Support
Blues.io
Notehub.io
Shop
Support
Blues.io
Notehub.io
Shop
×
HomeOperate
Notehub Walkthrough
Fleet Administrator's GuideDevice InformationEvent InformationSession InformationData HandlingFirmware ManagementOrganizational ToolingHardware Specific QR Codes

Fleet Administrator's Guide

Device Information

Notehub is built around a data set comprising of Notecard, Event, and Session data. The raw data collected from these sources is described in the JSON format. Notehub makes the data accessible through a graphical user-interface, which provides valuable insights and interactions with this data.

Raw Device JSON

The information contained in the JSON object is outlined in the following table:

KeyData TypeDescription
contactobjectContact information object
devicestringDevice UID
fleetstringFleet UID
latestobject
productstringProduct UID
provisionednumberProvisioning date (UNIX epoch timestamp)
session_activitynumber
session_begannumber(UNIX epoch timestamp)
session_towerobjectTower information object
session_tower.cstringTower location country
session_tower.cidnumberCell Identification
session_tower.lstring
session_tower.lacnumberLocation Area Code
session_tower.latnumberGeographic latitude
session_tower.lonnumberGeographic longitue
session_tower.mccnumberMobile Country Code
session_tower.mncnumberMobile Network Code
session_tower.nstringTower location city and state
session_tower.trinumber
session_tower.zonestringTimezone information
settingsobject
settings.modifiednumberModified date (UNIX epoch timestamp)
snstringProduct serial number
tempnumberAmbient temperature
voltagenumberVoltage on V+ pin

Navigating to Device Data

The device data JSON object can be found using the following steps:

  1. Select Devices from the left navigation bar.

    Devices menu

  2. Select a device from the list of devices.

    Device selected from list

  3. Select Details from the available options.

    Details option

  4. Select the JSON tab.

    JSON tab selected

Event Information

Notehub is built around a data set comprising of Notecard, Event, and Session data. The raw data collected from these sources is described in the JSON format. Notehub makes the data accessible through a graphical user-interface, which provides valuable insights and interactions with this data.

Raw Event JSON

The information contained in the JSON object is outlined in the following table:

KeyData TypeDescription
eventstringEvent UID
sessionstringSession UID
tlsbooleanTLS encrytped
devicestringDevice UID
snstringProduct serial number
productstringProduct UID
receivednumber
routednumberWhen the Note was transmitted to Notehub (UNIX epoch timestamp)
reqstringNotecard request API
whennumberWhen the Note was queued on the Notecard (UNIX epoch timestamp)
filestringNotefile name to which the Note was queued
notestring
updatesnumber
bodyobjectUser-defined Note payload
tower_whennumber
tower_latnumberCellular tower latitude
tower_lonnumberCellular tower longitude
tower_countrystringCellular tower country code
tower_locationstringCellular tower location (City/State)
tower_timezonestringCellular tower time-zone
tower_idstringCell Global Identity
movednumberlast epoch time that the device moved
orientationstringdescription of physical orientation (e.g. "face-up")
rssinumberReceived Signal Strength Indication
sinrnumberSignal-to-Interference-plus-Noise Ratio
rsrpnumberReference Signals Received Power
rsrqnumberReference Signals Received Quality
ratstringRadio Access Technology
barsnumberNumber of bars of cellular service
voltagenumberVoltage measured from power supply
tempnumberTemperature measured on chip
towersnumberConnected tower count
logattnbooleanEvent requires attention
logobjectRoute Log (list)
log.[rid*]objectRoute object
log.[rid*].attnbooleanRoute requires attention
log.[rid*].statusnumberError status code
log.[rid*].textstringError message
replystring

*An auto-generated route identifier, comprising of the application's unique identifier along with the route's unique identifier.

Navigating to Event Data

The event data JSON object can be found using the following steps:

  1. Select Events from the left navigation bar.

    Events menu

  2. Select an event from the list of events.

    Event selected from list

  3. Select Details from the available options.

    Details option

  4. Select the JSON tab.

    JSON tab selected

Session Information

Notehub is built around a data set comprising of Notecard, Event, and Session data. The raw data collected from these sources is described in the JSON format. Notehub makes the data accessible through a graphical user-interface, which provides valuable insights and interactions with this data.

Raw Session JSON

The information contained in the JSON object is outlined in the following table:

KeyData TypeDescription
sessionstringSession UID
devicestringDevice UID
productstringProduct UID
fleetstringFleet UID
addrstringProtocol, socket, and IP address
cellstringCellular global identity
ScanResults
rssinumberReceived Signal Strength Indication
sinrnumberSignal-to-Interference-plus-Noise Ratio
rsrpnumberReference Signals Received Power
rsrqnumberReference Signals Received Quality
ratstringRadio Access Technology
towerobjectObject describing tower information
tower.nstringTower location city and state
tower.cstringTower location country
tower.lstring
tower.latnumberGeographic latitude
tower.lonnumberGeographic longitue
tower.zonestringTimezone information
tower.mccnumberMobile Country Code
tower.mncnumberMobile Network Code
tower.lacnumberLocation Area Code
tower.cidnumberCell Identification
tower.trinumber
session_log_keystring
thisobjectObject describing Session transaction details
this.sincenumberPOSIX timestamp
this.bytes_rcvdnumberBytes received during this session
this.bytes_sentnumberBytes sent during this session
this.sessions_tcpnumber
this.sessions_tlsnumber
this.notes_rcvdnumberNotes received during this session
this.notes_sentnumberNotes sent during this session
nextobject
periodobject
period.sincenumberPOSIX timestamp
period.durationnumber
period.bytes_rcvdnumberBytes received during this session
period.bytes_sentnumberBytes sent during this session
period.sessions_tcpnumber
period.sessions_tlsnumber
period.notes_rcvdnumberNotes received during this session
period.notes_sentnumberNotes sent during this session
voltagenumberVoltage supplied to Notecard
tempnumberAmbient temperature of Notecard
continuousbooleanDescribes if continuous mode is enabled
tlsbooleanDescribes encryption status of session
worknumber
eventsnumberNumber of events that occurred during session
movednumberlast epoch time that the device moved
orientationstringdescription of physical orientation (e.g. "face-up")
triggerstringconfiguration details and reason for session establishment
LastWorkDonenumberPOSIX timestamp

Navigating to Session Data

The session data JSON object can be found using the following steps:

  1. Select Devices from the left navigation bar.

    Devices menu

  2. Select Sessions from the available options.

    Sessions option

  3. Double-click a session from the list of sessions.

    Select session Session selected

Data Handling

Notehub provides data handling capabilities for both data that was captured, or generated, by Notecards as well as data being sent to Notecards from Notehub.

Data Routing (ingress/egress)

A Route is an external API, or server location, where Notes are to be forwarded. A Route is established at the Project level, and by default will map every single transaction over a route. However, a route can also be filtered down to specific Notefiles and/or Fleets, allowing you to customize the amount of data you wish to share. Beyond filtering, any single event is capable of being multicast over several Routes, which gives you the ability to customize data ingress/egress to suit your needs.

For examples, view the Routing Tutorials

Data Origination

Not only can Notehub respond to data created by the Notecard, but it can send data to the Notecard as well. This functionality introduces interactive behaviors, configurations, and control.

Inbound Queues

Inbound may sound like a misnomer, but it was named from the perspective of the Notecard device. Therefore, when you load a Note into an Inbound Queue (.qi Notefile), that Note will be delivered the next time the Notecard device sychronizes with Notehub.

Environment Variables

Environment variables provide a tiered mechanism to propagate eventual consistency across a broad range of devices.

note

The Hierarchy of Environment Variables

Environment variables can be defined in a number of locations, from the Notecard, to Notehub device settings, the device's Fleet, and the Notehub project. Variables set at different levels of this hierarchy can override one another. When obtaining an environment variable, the Notecard uses the following priority order, where the fist matched result is returned:

  1. The value set on that Notecard with the env.set request.
  2. The value set in Notehub directly on Notehub's record for the Device.
  3. The value set in Notehub on a Fleet to which the Device belongs.
  4. The value set in Notehub on the Project to which the Device belongs.
  5. The value set on that Notecard with the env.default request.

Firmware Management

Notehub's ability to send and receive data has also been generalized to send firmware. Firmware can be uploaded to Notehub, then subsequently rolled out on a project, fleet or device scope. The firmware is not only limited to Notecards, it can also target the host MCU.

For more information regarding host DFU capabilities, please refer to the Notecard Walkthrough: Host Firmware Update Requests.

Organizational Tooling

Notehub.io provides organizational tooling to allow you to group devices into logical collections, which then allows you to query, route, or otherwise manipulate items in mass. Devices can be grouped into projects and fleets, and teams can be created around these groups to streamline work flows.

Team Management

Notehub allows you to easily create and maintain a list of users that have access and privileges to your projects. This allows a project to span multiple user accounts and enables project collaboration. You can easily create teams by adding members to Projects. Teammates can be given project, fleet, or view-only roles. Project Admin access grants a teammate full-access, allowing them to modify the project settings, along with the fleets and devices therein. Similarly, Fleet Admin access grants a teammate the ability to control all fleet level settings of a project, and the devices belonging to that fleet.

Project Management

Projects are the highest-order form of organization in Notehub. Projects enable you to organize multiple products into coherent groups. For example, a company could have a project called "Refrigerators". Under the Refrigerators project, they might have multiple products such as an upright refrigerator, a chest refrigerator, a side-by-side refrigerator, etc... As such, Projects offer a logical grouping of products under a user's account, and is the entrypoint for drilling into information regarding your set of devices and their transactions.

Project Level Actions:

  • team creation
  • fleet creation
  • route creation
  • firmware hosting
  • environment variable override
    • project-wide override
    • overrides default value

Fleet Management

Fleets are a way to further sub-divide a project into more granular device groupings. Fleet management is controlled at the project level, and allows you to interact with isolated groups of devices in the following ways:

Fleet Level Actions:

  • filtering
    • device, event and session information
    • data routing
  • environment variable override
    • fleet-wide override
    • overrides both default and project-wide values

Hardware Specific QR Codes

Each Notecard comes with a sticker containing a QR code unique that device. By default, the QR code links to the Quickstart Guide. Depending on the needs of your company, a redirect can be specified, allowing Notehub.io to serve as an abstraction, and forward the user to a company or product specific address.

  1. Navigate to Settings > Project, and find the QR Code Redirect URL section.

    QR Code Redirect URL section

  2. Fill in the field with the URL where you would like the QR Code to be forwarded.

    URL example with variables

    note

    Pay special attention to the variables specified in the URL above. You may use the variables device, sn (serial number), and product. These variables enable you to provide endpoints or URLs capable of being tailored to an individual device.

Can we improve this page? Send us feedbackRate this page
  • ★
    ★
  • ★
    ★
  • ★
    ★
  • ★
    ★
  • ★
    ★
© 2021 Blues Inc.Terms & ConditionsPrivacy
blues.ioTwitterLinkedInGitHubHackster.io
Disconnected
Disconnected
Having trouble connecting?

Try changing your Micro USB cable as some cables do not support transferring data. If that does not solve your problem, contact us at support@blues.com and we will get you set up with another tool to communicate with the Notecard.

Connect a NotecardClick 'Connect' and select a USB-connected Notecard to start issuing commands from the browser.