Application Provider Documentation
Application Providers manage and monitor the health of one or more applications on the network. The Application Provider Portal provides application management features and visibility into the state of end Devices.
Click on the header buttons to change the view.
Dashboard: Message and notification statistics
Events: View System Events, Application LoRa Events, and Device Management Events
Devices: Devices that have joined the network
Devices with Notifiers: Devices with custom notification targets
Alerts: Application notifier alerts
Device Management: Registered, Activated and deactivated Devices
Application Usage: Monthly and daily application statistics
Device Profiles and Contracts: Available Device profiles and contracts
The Details Panel displays application metadata. Click on the button to minimize.
The Dashboard view shows message and notification statistics for the managed application. Values are updated every 15 minutes. The selected time frame for the statistics can be set to 1, 7 or 31 days.
For Applications with more than one contract, the charts for Uplinks, Downlinks, Join Success and Join Errors support aggregation of the statistics by selected Contracts. The type of chart changes from line to column when Contracts are selected. This provides insight into the relative contribution of each Contract to the statistics.
The remaining charts are based on global statistics that cannot be scoped to specific Contracts. These do not support filtering by Contract.
|Chart||Description||Supports Contract Filtering|
|Up/Down||A combined chart showing the counts of Uplink and Downlink Device messages attributed to the Application.||Yes|
|Join Success/Join Error||A combined chart showing the counts of successful Device Joins and Join failures attributed to the Application.||Yes|
|Join Ignored||A chart showing the total number of ignored Join attempts attributed to the Application.||No|
|Notifications/Errors/Dropped||A combined chart showing the counts of successful, failed and discarded northbound messages attributed to the Application.||No|
|Avg. Request Time||A chart showing the average request time for forwarded northbound messages to all Application notification targets.||No|
The Devices view displays transaction data for Devices that have joined the SenRa Network on the managed application.
Use the Search bar to find Devices matching the selected field and search term.
The search is only executed against the selected field to optimize performance. A search for a Device Address with the Dev EUI field selected would not return results unless the Device Address also happened to match a Device EUI.
If a search for a full Device EUI fails, an option is provided to further search the Registered Devices. This is presented as a clickable link in the body of the Devices table.
If that search succeeds, information about the found Registered Device is presented in a popup.
Devices can also be filtered to show the Devices for one or more selected Contracts. Here, the Devices for the GeneticsLab Contract are shown:
Checking the Show Map checkbox shows the Devices on a map if either the actual or estimated locations are known.
Select Filter to Selected Devices to limit the Devices view to a select group of Devices. This filtered view can be shown with or without the Map.
Note: The RSSI and SNR columns include color-coded icons to reflect the strength and quality of uplinks from each Device. The following table provides the meaning of each color along with the corresponding value-range. When hovering over an icon, this text will be displayed as a tooltip.
|Green||Very Good RSSI: >= -95||Very Good SNR: >= 1|
|Blue||Good RSSI: > -110 and < -95||Good SNR: >= -6 and < 1|
|Yellow||Fair RSSI: >= -125 and < -110||Fair SNR: >= -13 and < -6|
|Red||Poor RSSI: < -125||Poor SNR: < -13|
Device Table Buttons
Update Devices: Upload a CSV file to update Device fields. SeeDevice Update for more information.
Device Configuration: Edit Information and Settings or Tags for the selected Devices
Refresh: Manually request the latest data
Settings: Control the column visibility
Export: Export the table to a Excel file
Firmware Upgrade: Update the firmware for the selected Device
Diagnostic Mode: Put selected Devices in Diagnostic Mode
The following Device information can be set in the Information and Settings dialog: Device Type, Device Profile, Device Class, Firmware Version, Latitude and Longitude and Metadata.
Exporting Device Service Metrics Data
Service Metrics data is calculated based on the terms of an associated Contract. The data can be exported from the Application Details Devices view.
Click on the Export button in the view to display a menu showing available export options.
Click on Export Service Metrics Data to show a dialog presenting a list of Contracts associated with the Application.
Select the desired Contract and Service Period and click the Export button to begin the export.
The data is exported to an Excel formatted file that appears in the lower left corner of the browser. The columns Metric A, Metric B and Metric C in the exported file, show the percentage of days within a 31 day period that a Device sent an uplink within the associated time window.
Enabling Diagnostic Mode for a Device adds it to the Developer Dashboard and enables notifiers. Devices with Diagnostic Mode enabled will appear in the Devices table with an icon next to their EUI. Clicking on an EUI will open the Device Details view. Diagnostic Mode can be enabled on a limited number of Devices. Please contact email@example.com to increase the limit for an account.
The Device Details view contains a series of sub-views that present Device centric transactional or location data. These views provide in-depth historical information that assists in troubleshooting Device behavior.
Transactions: Display LoRa transactional events for the Device.
Map: Displays the current location of a Device on a map.
RF Statistics: Display RF information for the Device in heatmap form.
Statistics: Display key LoRa transactional statistics for a Device.
Click on a Device EUI to open the Device Details view.
The Device Details Transactions view is a combined table and chart view that shows the communication events between the Device and the Network Server. The table shows the processed LoRa event data and the chart shows the statistics from those events over time. Events that are received late are specifically identified with light italicized text in the Time column.
The view can be filtered to specific event types or to communications involving specific Base Stations. The chart view will display the statistics from those filtered events and supports display of either one or two statistics at a time.
The Transactions view has several pre-defined filters to help troubleshoot LoRa network issues. These filters are only applied to events loaded into the view.
|Unique Uplinks/Downlinks||Filters to events with "Uplink" in the Type column and where the sub-string "dup=true" is not in the Details column. Includes Downlinks associated with the Uplinks.|
|Unique Uplinks||Filters to events with "Uplink" in the Type column and where the sub-string "dup=true" is not in the Details column. Excludes Downlinks associated with the Uplinks.|
|Join Activity||Filters to events with "Join" in the Type column.|
|Application Downlinks||Filters to Unique Uplink events, events with "Downlink" in the Type column, events with data in the Encrypted or App PDU columns and events with "Ack=true" in the Details column|
|ADR Activity||Filters to events with "ADR Check" in the Type column or events with any of the following strings in the Details column: "LinkADRReq","LinkADRAns", or "ADRAckReq=True".|
|ADR Disabled||Filters to events with "ADR=False"|
|Uplinks||Filters to events with "Uplink" in the Type column.|
|Downlinks||Filters to events with "Downlink" in the Type column.|
|MAC Commands||Filters events with a MAC command string appearing anywhere in the Details column.|
Events can be filtered to those that occurred at a specific point in time using the Date/Time filter. Click the button to open the limit and Date/Time filtering options for the view.
The options popup has two modes, a row limiting mode and a Date/Time filter mode. The row limit mode is used to define the number of events that are returned from the server. Limiting the number of rows returned generally improves data processing performance.
As noted, the Date/Time filtering mode is used to filter events to a specific point in time. Selecting a date and time, determines the starting point for the events that will be returned. The Duration value determines the maximum amount of time from the specified start time that events will be returned.
For example, starting at 7 a.m. with a duration of 1 hour will return events that occurred between 7 a.m. and 8 a.m if "Newer" is selected. Otherwise if "Older" is selected, events from 7 a.m. to 6 a.m. will be returned. Since the number of events that occur within a specified timeframe is variable, the Max Rows value is used to further limit the returned data.
By default, the Transactions view appends new events periodically every 30 seconds. This behavior is disabled when either a Date/Time filter is applied or the view is scrolled to a position other than the top of the table. Auto-refresh is re-enabled when either the view is refreshed or the view is scrolled back to the top.
An indication of the auto refresh status is displayed in the Transaction view's table footer as shown here:
The Device Details Map view provides a location context for the Device. The position of the Device may be actual or estimated depending on GPS support or activation of the estimated location feature. Historical positional data may also be available if the Device model includes that data when communicating with the Network Server. Like the main Map view, the Device Details Map view supports display of detailed Device information in the Map.
Path Quality information is also available:
Device RF Statistics
The RF Statistics view consists of three heatmap charts that show Uplink,SNR and RSSI statistics on a per-channel basis over time. The view supports daily or monthly aggregation of the data and supports navigation through time in 1 hour, 6 hour or 1 day increments.
The view also supports displaying the backing data in table format as shown here:
The Device Statistics view shows historical charts of important Device data, such as PSR, Data Rate, RSSI, SNR and others. The view supports displaying the statistics in hourly, daily and lifetime timeframes.
|PSR/Data Rate||A combined chart showing the Device's historical PSR and Data Rate for each displayed time period.|
|Avg. RSSI/SNR||A combined chart showing the Device's historical RSSI and SNR values for each displayed time period.|
|Redundancy||A chart showing a count of the Base Stations hearing the Device for each displayed time period.|
|Up Pkts||A chart showing the count of northbound packets sent to the Network Server for each displayed time period.|
|Down Pkts||A chart showing a count of southbound packets sent to the Device for each displayed time period.|
|Up Bytes||A chart showing the count of northbound bytes sent to the Network Server for each displayed time period.|
|Down Bytes||A chart showing a count of southbound bytes sent to the Device for each displayed time period.|
|ADR Requests||A chart showing a count of the Data Rate requests that occur due to ADR for each displayed time period.|
|ADR Configuration Changes||A chart showing a count of the Data Rate changes that occur due to ADR for each displayed time period.|
|Up MAC Commands||A chart showing the count of the unique northbound packets containing MAC commands.|
|Down MAC Commands||A chart showing the count of the unique southbound packets containing MAC commands.|
|Join Requests/Accepts||A combined chart showing a count of join requests sent by the Device and counts of join accepts sent to the Device for each displayed time period.|
|Security Sessions||The number of successful joins processed for each displayed time period|
MAC Commands used for Up/Down counts: ADRParamSetup, DeviceTime, DevStatus, DlChannel, DutyCycle, LinkADR,LinkCheck, NewChannel, Rekey, Reset, RXParamSetup, RXTimingSetup, BeaconFreq,BeaconTiming, PingSlotFreq, PingSlotInfo, DeviceMod
The Details Panel on the left side of the image above allows users to create or edit a custom Notification Target, send downlinks and view Device information and statistics. Click on the button to minimize.
Details: Display current information about the Device
Send Downlink: Send downlink PDUs to the Device
Edit Device: Open the Edit Device window (see below). This button is only visible if Diagnostic mode is enabled for the Device.
On-demand application downlinks can be sent directly from the Device Details view. A message is sent by specifying the message PDU and the target port on the Device. Message confirmation is enabled by checking the corresponding checkbox.
When operating as Class-B or Class-C, the Device's Details Send Downlink UI will display a Device Class selector.
Downlink options include:
- Class-A: Queue the downlink until the next uplink receive windows are available
- Class-B: Do not queue; send the downlink to the elected base station for transmit on the available next ping slot
- Class-C: Do not queue; transmit immediately.
Create a custom Notification Target or edit the previously configured Notification Target. Devices with custom Notification Targets will appear in the Devices with Notifiers view. See the Developer Streaming documentation for more details.
The Application Events view provides a consolidated view of the LoRa events associated with the Application. Like other event views, the Application Events may be filtered by date and time to focus events that occurred at a specific point in time. Events may also be traversed historically using the "More" button. Events that are received late are specifically identified with light italicized text on the Time column.
System events are system level events for the Application and Join Servers. This table allows you to navigate these events to help troubleshoot issues with the Application.
Clicking on a system event allows you to view the details of the event.
Device Management Events
Device management are specific audit events generated by Device management changes. They contain the details of the changes including; The time the changes took place, which Devices were changed (Ids), who completed the changes (Username), and how the changes were performed (Authentication). Events are generated in batches of 500 devices so it is not uncommon to see several events for a single change.
You can view the details of an event by clicking on a row in the table which launches a dialog.
Devices with Notifiers
Streaming data for Devices with custom notification targets are displayed in the Device with Notifiers view.
Use the Search bar to find Devices by their EUI.
Refresh: Manually request for the latest data
Settings: Control the column visibility
Export: Export the table to a CSV file
Edit Device Notifier: Edit the selected Device's notification target.
Devices must be in diagnostic mode in order to edit their notifier. If a Device is not in diagnostic mode, it can be enabled using the Toggle Diagnostic Mode button.
Toggle Diagnostic Mode: Toggles the diagnostic mode state of a Device within the notifiers table. Rows marked with the same icon as the button are already in diagnostic mode.
Disabling diagnostic mode removes the notifier. Doing so from this table will remove the Device from the table.
The Device Management view shows Device onboarding data.
Use the Search bar to find Devices by their EUI.
Upload: Upload a CSV file to Register, Activate or Deactivate Devices
Activate/Deactivate: Activate or Deactivate the selected Devices
Request Token: Request a Device registration token
Refresh: Manually request for the latest data
Settings: Control the column visibility
A Device Profile can be leveraged to serve multiple purposes, it allows for the configuration of certain Device attributes that aide the network in properly managing the Device behavior. For example, the profile allows for the definition of an expected transmit interval. This transmit interval helps to identify how well a Device is performing against its daily expected communication profile.
The Device Profile also allows for the configuration of certain options that can be useful during testing and QA efforts. For example, the minimum/maximum Data Rate or range that a Device can operate at can be defined through the profile. A Device can be forced to operate at a Data Rate that is either higher or lower than that which the network would normally decide. Additional attributes that can be controlled include, but are not limited to; Tx power, Channel Plan, operational LoRa Version of the Device.
The Device Contracts view shows all Contracts created for the Application that can be used to group Devices for billing and usage data collection. See the Device Contracts section under Application Usage and Accounting for more details.