Project:Box identification

From London Hackspace Wiki
Revision as of 19:48, 3 June 2013 by Montyphy (talk | contribs)
Jump to: navigation, search
Box Identification
Created 01/02/2012
Members Montyphy asc Akki14
QR code


Brief

The members personal storage area

There are a few very minor issues with the Members Storage Boxes. Firstly, it's not easy to describe the location of a box to another member. Secondly, it's not easy to tell if a box on the shelf is owned by an active member.

Aims

  • Label each bay of the storage shelves with location indicators.
  • Label each member's box with a QR code representing its ID which can then be used to query information about its owner. The QR code is just for convenience so the label should also include a human readable version of the query.
  • Create an interface to allow members to maintain the location and ownership of their box(es).
  • Create an interface for members to represent and share information about the location of their box.
  • Create an interface for searching the name/nickname/member_id/box_id/ to get the location of their box.
  • Create an interface for admin maintenance e.g. finding unused boxes or locations, finding non-member boxes, freeing up allocated boxes no longer used.

Use Cases

  • Identify a box - Lookup a QR code or ID that's on a box and get told who owns it or owned it last and where it should live on the shelves.
  • Locate all boxes owned by people without an active subscription.
  • Label a group of new boxes - For a given number, create new box instances in the database and output a batch of QR codes.
  • Relabel a group of existing boxes - For a given range of IDs, output a batch of corresponding QR codes.
  • Lookup the location of a member's box using their nickname.
  • Lookup the location of a member's box using their name.
  • Lookup the location of a member's box using their member id.
  • Express the location of a member box - A link that will provide a visual representation of where a box is.
  • Take ownership of a labelled box.
  • Take ownership of a previously unlabelled box.
  • Renounce ownership of a box.
  • Allow a member to set the location of their box.
  • Decommission a box - in the event a box goes missing, gets damaged, reassigned as non-member storage, converted into a memorial box, or otherwise prevent reuse of that particular ID/box.
  • Allow a box to be owned by more than one person - due to space limitations some people share boxes.

Decisions/Progress

  • Shelf locations will have the format /s\d\db\d\d/ e.g. s01b10. With the first segment (/s\d\d/), e.g. s01, representing the shelving unit and the second segment (/b\d\d\/), e.g. b10, representing the bay on that particular unit.
  • Shelf bays will have to be labelled sequentially left to right, bottom to top to account for when people double stack the top bays (triple stacking is silly and is not supported).

Code

Database

  • Boxes shouldn't be deleted from the database, nor should the owner_id column be set to NULL, as this could result in the loss of useful information such as who owned the box last. Instead, boxes can be marked as inactive or unowned.
  • Created migration scripts to upgrade and downgrade any database changes. The benefit of this is it makes it easy to seed the database with valid locations while minimising the risk of the changes causing a problem to the live database through a failed action (the migration is transactional so an error will cause it to rollback to the previous stable state and not leave it in a horrible half migrated mess)
  • Access database
sqlite3 var/database.db
  • Upgrade migration
sqlite3 var/database.db < etc/migrations/0001_upgrade.sql
  • Downgrade migration
sqlite3 var/database.db < etc/migrations/0001_downgrade.sql

Database Design

  • Box
    • creator_id (Reference ID) - As anyone will be able to create a new box record this would be handy for identifying when people aren't being excellent i.e. someone spams the create button.
    • owner_id (Reference ID) - Who owns the box/contents. The idea is that this will only get updated on claiming the box so it will be possible to identify old owners if they left something in the box after disowning it.
    • owned (BOOLEAN) - If the assign owner still wishes to own the box.
    • active (BOOLEAN) - Overengineering at its finest, this serves no real purpose but is intended to take a particular box out of service. (Admin use only)
    • location (Reference ID) - Where the box is located. Could be NULL, as in there's no valid place for it on the shelves.
  • Storage Locations - A representation of all valid storage locations. shelf and bay combine to create a UNIQUE key.
    • shelf (Reference ID) - refers to a shelf unit
    • bay (Reference ID) - refers to a shelf bay
  • Storage Unit
    • key (CHAR(2)) - Unique string representing unit
    • x (INTEGER) - x-coord in pixels for positioning shelf unit marker on box location image.
    • y (INTEGER) - y-coord in pixels for positioning shelf unit marker on box location image.
    • orientation (INTEGER) - Orientation of the shelf unit for box location image. (N = 0, E = 1, S = 2, W = 3)
  • Storage Bay
    • key (CHAR(2)) - Unique string representing bay
    • x (INTEGER) - x-coord in pixels for positioning shelf bay marker on box location image.
    • y (INTEGER) - y-coord in pixels for positioning shelf bay marker on box location image.

Images

  • QR codes are generated using a Google API. (Same way this wiki does it)
  • Location images will be created using two image markers (one for indicating the unit and one for indicating the bay) that overlay two base images (one representing an overhead view of the shelves and one representing the usable bays of a unit). (See images in the gallery)

Image Generation

  • A location indicator can be generated by visiting /members/storage_image.php and attaching a box location with '?loc=' e.g.
/members/storage_image.php?loc=s16b03

will create: Montys box location.png

  • A box identification label can be generated by visiting /members/storage_image.php and attaching a box id with '?id=' e.g.
/members/storage_image.php?id=4 

will create: Example box qr code.png

  • A range of QR codes can be generated for labelling boxes by visiting /members/storage_image.php a start id with '?start_id=' and optional end id with '&end_id=' e.g.
/members/storage_image.php?start_id=1&end_id=10

will create a page containing something like: Qr codes sheet.png

  • Two of each ID are produced for the QR code sheet in order to label both short sides of the box.

To Do

Physical

  • Label the boxes.
  • Label the shelves. Please let me know if any labels drop off and I can print replacements --Akki14 23:42, 28 February 2012 (UTC)
  • Assign boxes to correct members.
  • Assign boxes to their locations.

Database

  • Represent a storage location.
  • Represent a box.
  • Migration script to populate database with storage locations
  • Modify schema to handle multiple owners.

Image Generation

  • API for creating box location images.
  • API for creating box labels.
  • API for creating numerous box labels by providing a range of IDs.

User Interface

  • Admin maintenance for helping with physical setup.
    • Create one or multiple boxes (Montyphy 08:58, 13 March 2012 (UTC))
    • Assign member
    • Assign location
    • Disown
    • Disable
  • Member maintenance of personal storage.
    • Create a box.
    • Claim a box. (Montyphy 01:23, 1 March 2012 (UTC))
    • Disown a box. (Montyphy 01:23, 1 March 2012 (UTC))
      • Don't set user_id to NULL, instead change Owned to False.
    • Assign a box to a location. (Montyphy 01:39, 1 March 2012 (UTC))
      • Make more user friendly by making a select box of unclaimed boxes (Montyphy 10:12, 13 March 2012 (UTC))
    • Generate label for claimed box (Montyphy 01:27, 1 March 2012 (UTC))
    • Generate location indicator (Montyphy 01:40, 1 March 2012 (UTC))
  • Box lookup e.g. searching name or location.
  • Box identification e.g. QR code / ID lookup.
    • List info about owner e.g. name, member status (Montyphy 02:43, 1 March 2012 (UTC))
    • List info about where the box should be on the shelves.
    • Handle multiple owners.
    • Option to claim box if no one owns it
  • Input validation

Gallery