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:
| Key | Data Type | Description |
|---|---|---|
| contact | object | Contact information object |
| device | string | Device UID |
| fleet | string | Fleet UID |
| latest | object | |
| product | string | Product UID |
| provisioned | number | Provisioning date (UNIX epoch timestamp) |
| session_activity | number | |
| session_began | number | (UNIX epoch timestamp) |
| session_tower | object | Tower information object |
| session_tower.c | string | Tower location country |
| session_tower.cid | number | Cell Identification |
| session_tower.l | string | |
| session_tower.lac | number | Location Area Code |
| session_tower.lat | number | Geographic latitude |
| session_tower.lon | number | Geographic longitue |
| session_tower.mcc | number | Mobile Country Code |
| session_tower.mnc | number | Mobile Network Code |
| session_tower.n | string | Tower location city and state |
| session_tower.tri | number | |
| session_tower.zone | string | Timezone information |
| settings | object | |
| settings.modified | number | Modified date (UNIX epoch timestamp) |
| sn | string | Product serial number |
| temp | number | Ambient temperature |
| voltage | number | Voltage on V+ pin |
Navigating to Device Data
The device data JSON object can be found using the following steps:
Select Devices from the left navigation bar.
Select a device from the list of devices.
Select Details from the available options.
Select the JSON tab.
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:
| Key | Data Type | Description |
|---|---|---|
| event | string | Event UID |
| session | string | Session UID |
| tls | boolean | TLS encrytped |
| device | string | Device UID |
| sn | string | Product serial number |
| product | string | Product UID |
| received | number | |
| routed | number | When the Note was transmitted to Notehub (UNIX epoch timestamp) |
| req | string | Notecard request API |
| when | number | When the Note was queued on the Notecard (UNIX epoch timestamp) |
| file | string | Notefile name to which the Note was queued |
| note | string | |
| updates | number | |
| body | object | User-defined Note payload |
| tower_when | number | |
| tower_lat | number | Cellular tower latitude |
| tower_lon | number | Cellular tower longitude |
| tower_country | string | Cellular tower country code |
| tower_location | string | Cellular tower location (City/State) |
| tower_timezone | string | Cellular tower time-zone |
| tower_id | string | Cell Global Identity |
| moved | number | last epoch time that the device moved |
| orientation | string | description of physical orientation (e.g. "face-up") |
| rssi | number | Received Signal Strength Indication |
| sinr | number | Signal-to-Interference-plus-Noise Ratio |
| rsrp | number | Reference Signals Received Power |
| rsrq | number | Reference Signals Received Quality |
| rat | string | Radio Access Technology |
| bars | number | Number of bars of cellular service |
| voltage | number | Voltage measured from power supply |
| temp | number | Temperature measured on chip |
| towers | number | Connected tower count |
| logattn | boolean | Event requires attention |
| log | object | Route Log (list) |
| log.[rid*] | object | Route object |
| log.[rid*].attn | boolean | Route requires attention |
| log.[rid*].status | number | Error status code |
| log.[rid*].text | string | Error message |
| reply | string |
*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:
Select Events from the left navigation bar.
Select an event from the list of events.
Select Details from the available options.
Select the JSON tab.
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:
| Key | Data Type | Description |
|---|---|---|
| session | string | Session UID |
| device | string | Device UID |
| product | string | Product UID |
| fleet | string | Fleet UID |
| addr | string | Protocol, socket, and IP address |
| cell | string | Cellular global identity |
| ScanResults | ||
| rssi | number | Received Signal Strength Indication |
| sinr | number | Signal-to-Interference-plus-Noise Ratio |
| rsrp | number | Reference Signals Received Power |
| rsrq | number | Reference Signals Received Quality |
| rat | string | Radio Access Technology |
| tower | object | Object describing tower information |
| tower.n | string | Tower location city and state |
| tower.c | string | Tower location country |
| tower.l | string | |
| tower.lat | number | Geographic latitude |
| tower.lon | number | Geographic longitue |
| tower.zone | string | Timezone information |
| tower.mcc | number | Mobile Country Code |
| tower.mnc | number | Mobile Network Code |
| tower.lac | number | Location Area Code |
| tower.cid | number | Cell Identification |
| tower.tri | number | |
| session_log_key | string | |
| this | object | Object describing Session transaction details |
| this.since | number | POSIX timestamp |
| this.bytes_rcvd | number | Bytes received during this session |
| this.bytes_sent | number | Bytes sent during this session |
| this.sessions_tcp | number | |
| this.sessions_tls | number | |
| this.notes_rcvd | number | Notes received during this session |
| this.notes_sent | number | Notes sent during this session |
| next | object | |
| period | object | |
| period.since | number | POSIX timestamp |
| period.duration | number | |
| period.bytes_rcvd | number | Bytes received during this session |
| period.bytes_sent | number | Bytes sent during this session |
| period.sessions_tcp | number | |
| period.sessions_tls | number | |
| period.notes_rcvd | number | Notes received during this session |
| period.notes_sent | number | Notes sent during this session |
| voltage | number | Voltage supplied to Notecard |
| temp | number | Ambient temperature of Notecard |
| continuous | boolean | Describes if continuous mode is enabled |
| tls | boolean | Describes encryption status of session |
| work | number | |
| events | number | Number of events that occurred during session |
| moved | number | last epoch time that the device moved |
| orientation | string | description of physical orientation (e.g. "face-up") |
| trigger | string | configuration details and reason for session establishment |
| LastWorkDone | number | POSIX timestamp |
Navigating to Session Data
The session data JSON object can be found using the following steps:
Select Devices from the left navigation bar.
Select Sessions from the available options.
Double-click a session from the list of sessions.
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.
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.
Navigate to Settings > Project, and find the QR Code Redirect URL section.
Fill in the field with the URL where you would like the QR Code to be forwarded.
