Automatically translate this page?

Toolbox guide

Detailed logs, real-time & historical messages, intervals, and so much more in a handy and functional interface.

Overview

Toolbox is a comprehensive instrument giving a complete understanding of what has happened to the flespi platform in each specific moment. It offers all available records (logs and messages) about all functional elements in your flespi account.

The entities are grouped into the following logical sections:

Accessing Toolbox

You can access Toolbox in several ways whichever is more convenient:

(i) Find the Toolbox item inside the Telematics hub, Storage, or MQTT menu section to open the respective Toolbox view:

flespi panel open toolbox

or (ii) navigate to the Toolbox tab on the item's card (available for all item types):

toolbox tab for flespi item

or (iii) open Toolbox separately at the link https://toolbox.flespi.io/:

standalone flespi toolbox

Note that when opened as a standalone application, Toolbox offers convenient filtering within one element type (e.g. channels, devices, etc.). You can filter all item types by name or id, and additionally can filter devices by ident (IMEI).

flespi toolbox filter items

Access by token

If you want to give a 3rd party (e.g. a hardware manufacturer, co-worker, etc.) access to a certain device (or a list of devices), you can generate an ACL token for them with the following permissions:

toolbox acl token

Then you can give the link of the following format to the 3rd party:

https://flespi.io/toolbox/#/login/{Token-with-ACL-to-specific-devices}

Main screen

When you open Toolbox for a particular item it will show either logs and messages panes (for channels and devices) or only logs page (for platform, streams, modems, calcs, plugins).

flespi toolbox main screen

Right sliding pane

Clicking on the message or log entry will open its detailed view in the right-side pane. The pane also allows seeing the message as a JSON object and see the map with the location received in the respective message parameters (position.latitude and position.longitude):

flespi toolbox right sliding pane

You can detach the pane and move it to any position on the screen:

flespi toolbox detach right pane

Columns management

Add/remove columns

You can customize the set of displayed columns and their order. 

To add a new column, right-click anywhere on the table header and pick Add column

flespi toolbox add column

Then start typing the column name and pick the needed column from the list:

flespi toolbox find column to add

To delete a column right-click on its header and pick Remove column:

flespi toolbox remove column

Drag the column by its header to change its position in the table.

Column presets

Use the three dots menu to the right of the date picker to revert to default columns or to columns defined by the protocol schema.

Once you configure the columns layout differently from the default setup, you will be able to save your own column preset.

flespi toolbox columns management

Logs pane

Logs pane is available for ALL item types. Logs include entries about all the events associated with the specific item. The colors of log records are intended to drag attention to more important events (usually related to the modification, deletion, errors, and warnings). 

flespi toolbox logs pane

Searching logs

Use the search bar to narrow down the log records to a subset meeting specific criteria. Search by any parameter(s), use logical operations (=, <>, >, <=, etc.) and wildcards (*). When listing multiple criteria separated by a comma, AND logic applies.

flespi toolbox search logs

Note that the parameter name you need to specify in the search bar may not be the same as the parameter column header. You can find the proper name in the log record or message JSON.

Filtering logs

Filter logs by event type to get only the records you care about:

flespi toolbox filter logs by event type

Messages pane

Messages pane shows the messages received from the physical device or OEM platform parsed according to the protocol specification. The default set and order of the displayed column depends on the protocol schema and can be customized at any time.

flespi toolbox messages pane

Searching messages

Use the search bar to narrow down the messages to a subset meeting specific criteria. Search by any parameter(s), use logical operations (=, <>, >, <=, etc.) and wildcards (*). When listing multiple criteria separated by a comma, AND logic applies.

flespi toolbox messages search

Message colors

Toolbox color-codes device messages depending on their "freshness" — the further the message arrival time from the current time, the darker it will show in the list:

flespi toolbox messages colors

Context menu

Right-clicking on a message opens the context menu with some helpful options:

flespi toolbox context menu

  • Copy option will copy the specific value in the cell on which the right-click was made

  • Copy message will copy the entire message with all parameters as the JSON object

  • Show message will open the right sliding pane with the full message object

  • View in traffic will open the Traffic Viewer tool and show the raw representation of the selected message 

  • Show on map allows quickly seeing the dot on the map with the latitude/longitude taken from the selected line.

Intervals

Intervals are a different entity generated based on multiple messages. Intervals have a separate view available for devices with assigned calculators only:

flespi toolbox intervals

Once in the Intervals mode, you should pick the desired calculator assigned to the selected device to see the intervals for:

flespi toolbox interval mode

Map 

A built-in map for quick dot-on-the-map visualization is available for devices only (since they correspond to the vehicles or assets being tracked).

You can click on the Map button at the top right of the screen to see the last position of the current device based on its position.latitude and position.longitude parameters stored in telemetry.

flespi toolbox open map

Tools

Toolbox has a few complementary tools that may be helpful for advanced debugging and troubleshooting.

Traffic Viewer

Traffic Viewer is a handy tool to analyze raw messages from any IoT and telematics devices (supported in flespi). 

You can see the raw traffic data for any channel or device in your flespi account:

flespi toolbox traffic viewer

When opening Traffic Viewer for a channel, you will be prompted to pick the specific ident to show the traffic for.

flespi traffic viewer hex message

Read more about the tool here.

HEX Viewer

This tool works for proxy channels only and allows investigating data packets in raw hexadecimal format with more convenience. Check the dedicated article here.

***

Despite being such a powerful and multi-functional tool, Toolbox will be getting occasional updates when our developers implement their new bright ideas. To stay in sync with the latest changes, subscribe to the Toolbox change log on our forum.


See also
Get the complete list of message parameters you can consume from flespi.
Export location data in popular geo formats (KML, GPX, GeoJSON).