0.1 WorkPoint

CoWorkr’s Sensor hardware, called a “WorkPoint”,  reports an occupancy state, using various methods of sensing. WorkPoints report a reading of “Occupied” instantaneously and otherwise, if no change of status is observed, a WorkPoint has a “heartbeat” that reports an update to CoWorkr every minute, letting CoWorkr know it’s online. WorkPoints also contain a notification button that reports to CoWorkr if pressed.

WorkPoint Versions:

    V1 - Version 1 WorkPoint that uses temperature or vibration sensing (no longer available)

    V2 - Version 2 WorkPoint that uses temperature or vibration sensing

    V3 - Version 3 “Motion” WorkPoint that uses passive infrared (PIR) sensing

WorkPoints attributes:

WorkPoint UUID:  Unique string defined by a WorkPoint’s Bluetooth radio, for example “B827EB13B5F2”

WorkPoint ID: Unique string assigned to a WorkPoint when created on CoWorkr, for example, “54f45a67ac641604fd9bfa1a”.

Name: A custom value assigned by users via CoWorkr’s app. Its default value is the WorkPoint’s UUID.

Firmware: The version of firmware running the WorkPoint.

Notes: A custom field for users to input misc. information regarding a WorkPoint

WorkPoint Statuses: The state of a WorkPoint changes with time and its sensor status. The following states may exist:

      connected - true if the WorkPoint has reported to the server within an anticipated time frame, false if hasn’t recently reported to the server

      recentlyConnected: (CoWorkr Admin use only) 

      occupied - true if the workPoint is reporting an occupied state, false if not occupied 

      occupiedBy - (CoWorkr Admin use only) string with admin info on the occupied state

      occupyReason - (CoWorkr Admin use only) string with admin info on the occupied state

      occupancyChanged - timestamp of the last reported change in status

      flags.press - A notification button on the WorkPoint has been pressed 

      flags.button1 - WorkPoint Notification Button 1 has been pressed

      flags.button2 - WorkPoint Notification Button 2 has been pressed 

      rssi - (CoWorkr Admin use only) signal strength

      battery - (CoWorkr Admin use only)

      optical - (CoWorkr Admin use only) if available, a light intensity reading


0.2 WorkHub 

CoWorkr’s internet-enabled device that reads and pushes WorkPoint data to CoWorkr’s servers. WorkHubs, or “Hubs”, require an internet connection using LAN, WiFi, or Cellular dongle to operate. 

WorkHub Attributes:

WorkHub ID: Unique string given to a WorkPoint when placed onto a Floorplan, for example, “54f45a67ac641604fd9bfa1a”

WorkHub UUID: Unique string associated with a WorkHub’s Bluetooth radio, for example “CE27EB1455F1”

0.3 WorkPlace

A physical location from where WorkPoints and Workhubs are streaming. A WorkPlace is generally used to represent a single location that is based on a geographical address - for example, a building. WorkPlaces contain one or more Floorplans to which WorkPoints and WorkHubs are assigned. 

WorkPlace Attributes:

WorkPlace ID: A unique case-sensitive alphanumeric identifier, for example “YvamDKDx6KD4QZh5g”, given to a WorkPlace on creation.

WorkPlace Name: A custom field assigned to the WorkPlace by a user.

Address: The physical location of the WorkPlace. This is also used to pair with geolocation services of WorkHubs.

Timezone: The local timezone of the WorkPlace. 

Group: A grouping of users with specific access permissions. Groups are generally created for each customer to segment access but may also be a group of users that belong to a 3rd party that oversees multiple customers. A group is identified by a given Name and a case-sensitive alphanumeric ID, for example “nzYf5H8RNBYSgrLHJ’

Start & End: “Start Date” is the first day the data is to stream from a corresponding WorkPlace.  “End Date” is the day the data at the corresponding WorkPlace will end its streaming. These dates are generally defined by the customer’s subscription period.

Active Hours: “Active Start Hour“ and “Active End Hour” hours determine a range of time wherein occupancy data will be ignored for a specific WorkPlace. This generally is used to eliminate occupancy data created outside of working hours such as that created by late-night cleaners. This is a custom field that can be set by an admin.

0.4 FloorPlan

An image file used as a background for CoWorkr’s floorplan view on which WorkPoints are placed. This is commonly a cad-based 2D drawing that has been exported as a raster image like jpeg or png.

FloorPlan Attributes:

FloorPlan ID: A unique string assigned to a FloorPlan upon creation.

FloorPlan Name: A custom, required, field given to the FloorPlan image upon upload.

FloorPlan X, Y: A location on the FloorPlan using a X-Y coordinate system, typically used to describe a WorkPoint location 

Location: A X,Y coordinate that locates a WorkPoint icon on a Floorplan image on CoWorkr’s App

0.5 Tags

Values assigned to WorkPoints to describe, but not limited to, the physical location or the use of the space. Tags contain 2 values, a category and a value associated with that category. For example, a tag category/value for a WorkPoint assigned to a workstation may be “furniture/desk”.