Wiki
Clone wikiNumera.LibrisAPI / EventDictionary
Home > Event Dictionary
Event Dictionary
Every event published by the Libris platform contains unique data that only relates to that event. This is the master list of events that you can have configured to be sent to your event receiver and that you will be able to view in the Libris web portal.
It is assumed that each event generated by the device is transmitted when the device is placed in the charger unless noted otherwise.
Complete Event Listing
| Event Type | Displays As | Description | Triggered By |
|---|---|---|---|
| LocationFix | Location update | A Location fix (satellite or network) was obtained | Device The device will trigger this event whenever it obtains a location fix. The event will not be published immediately under normal circumstances unless the device is in the charger. Through other configuration entries, these events can be published to the platform outside of the charger. The location.flush_during_call configuration item (when set to 'true') will allow the device to transmit any of these events immediately whenever a call has been placed. The location.publish_rate configuration item (when set to something besides 0) will allow the device to transmit location events when the configured number of fixes has been obtained. For example, if this value was set to 6, then once 6 fixes have been queued up then all 6 will be transmitted to the back-end even if the device is not in the charger. |
| Normal | Call | User initiated phone call from a button press | Device Sent immediately as the device initiates the call. |
| ON | Powered on | The device turned on or started after a reboot | Device |
| Classify | Classify | Event created when analyzing activity for a fall | Device The device generates this event whenever it sends data to the back-end to be analyzed to determine if the device has been involved in a fall. The event is transmitted immediately. |
| Note | Notes updated | A Patient note was updated | Platform |
| Status | Status | Status log entry | Device |
| Debug | Debug | Debug log entry | Device and Platform |
| ChargeChange | Charge status | Indicates state of charging | Device Generated whenever the device is placed in the charger or taken out of the cradle. The event generated when the device is removed from the cradle is generally not transmitted until the device is put back in the charger. |
| NetworkChange | Network | Network availability change | Device Generated when the strength of the network changes or the network is completely lost or re-obtained. |
| Fall | Fall Assistance Call | Fall detected and call initiated | Device Generated when the back-end determined a fall occurred and the device initiates a call to process the fall. The event is transmitted immediately. |
| Logfile | Unknown | A request to download logs | Device When support requests the device to transmit log files this event is generated on the device. |
| BatteryLow | Low Battery Alert | Device has crossed the critical threshold of charge | Device Generated when the current battery level has crossed the critical level. (60% of battery) The first audio message for the user plays at 62% and the last critical message plays at 52%. This event transmits immediately. |
| Activation | Device Activation | Device was activated | Platform As a result of a user activating the device or an API call. |
| FailActivation | Device Fail Activation | The activation failed | Platform |
| Deactivation | Device Deactivated | Device de-activated in UI or through API | Platform |
| MagCalibration | Magnetometer Calibration | Device was re-calibrated based on device's location | Platform The platform monitors for the device moving at least 150 miles from current location, and then re-calibrates the magnetometer values used by the classifier. |
| LowActivityAlarm | Low Activity Alarm | User has not had significant movement for the duration configured | Device This event transmits immediately. |
| LongChargeAlarm | Long Charge Alarm | Device left in charger too long | Device |
| MedicalDevice | Medical Device Alert | Generated as part of Libris+ events | Device and Platform The events are used to communicate the status of device pairings and readings. |
Base Event Fields
All events have the possibility of containing the following pieces of information that can be output to the event receiver. Specific use of the fields will be detailed for each event.
| Field | Description |
|---|---|
type | A string representing the type of event, from the listing above:Normal |
time | Time of the event in UTC, formatted as below:2012-08-14T16:41:27.887948 |
id | Numera identifier for the event, a long string:502a7fb72a76376afb000003 |
patient_id | Numera identifier for the patient owning the event, as a long string:502a7fb72a76376afb00001c |
imei | 15 digit identifier for the device the event relates to, as a string:358859040035380 |
ticket | A string identifier used to reference the specific call event (from a Normal, Classify, or Fall event), the syntax is realm-imei-rvid:BL-358859040035380-3986698555 |
rv | The "rendezvous" id, an integer representation of the session related to the data connection established for the Normal, Classify, or Fall event:3986698555 |
state | A string representing the current state of the event, will change meaning depending on event type:Complete |
caller_id | A string representing the MSISDN (phone number) assigned to the device associated with the event:5551221212 |
customer_id | A string representing the customer id (if any exists) entered in our platform for the patient (event collector) associated with the event:ABC123 |
event_data | A JSON array containing entries about the data transmitted by the device during a call event (Fall, Classify, Normal). See the Normal Event details below for details on the array / object structure. |
realm | Realm the device belonged to when the event was created |
device_status | status of the device |
device_name | name of the device (typically used by your platform to store your own identifier for this device) |
location | A JSON object containing details about a fix related to the event. See the LocationFix event details (will be set to "null" if not present). |
In addition to the fields above, for some events there will be a details object included that can have several additional properties that will be detailed in each event's documentation.
Updated