The Toit console is the name of the dashboard for the Toit cloud.
In the upper banner, a three dots icon to the right leads to the documentation, as well as three different online platforms where it is possible to communicate with the Toit team and community: ask a question about the Toit platform or the Toit language in Stack Overflow, chat with us on the Toit Slack workspace and report bugs using the
toitware/public GitHub repository.
This page lists all devices claimed by your organization. Click on the upper right corner buttons to Claim or replace device or Start a simulator with the firmware version of your choice.
In full screen, the page lists
The devices' name. An icon reflects the health of each device: red indicates that the device has missed its last check-in or that the device firmware is no longer available in the console; the circle means that the device is expecting an update next time it comes online, or that the update is currently taking place; green means that the device is behaving as expected. Hover over the device icon to see a tooltip explaining the reason(s) why your device is not classified as green.
The power icon indicates if the device is plugged in a power source, or shows for battery-powered device how much power was left last time the device was connected to the console.
The firmware version currently running on the device.
A warning sign next to the firmware version number means that the firmware installed on the device does no longer have a corresponding version available in the console. The currently installed programs will keep on running as they were previously, but to install new apps, the device firmware needs to be updated to an available SDK version.
Last seen gives the relative time to when the device was last seen, that is the last time it was online. Now indicates that the device is currently online. Unknown describes a new device which is part of your organization but has never connected to the console yet.
Next check-in gives the time when the device is expected to be online next, or how long ago it missed an expected check-in.
Id lists the unique Ids given to each device when claimed. Copy a device ID using the clipboard icon.
You can sort devices according to each of these information by clicking on the column header.
The Search field allows the search for devices by name, ID, or firmware versions.
Select a device to open additional functionalities. These are described in detail here. Click on the Devices page to the right to return to the initial list of devices.
The fleet health page collects devices' statuses for all devices of an organization.
At the top, devices are represented by boxes of different colors based on their current health: green for a device that behaves as expected, and red otherwise. A tooltip indicates the name of the device and the list of pending actions or issues for that device.
The overall status section compiles devices based on their health issues - or lack thereof. Note that a device can be counted in more than one category, except for devices in the "No issues category" that is exclusive of all others. Click on the "Go to devices" link to see the list of devices filtered according to their status or issue.
The playground is a terminal window where you can write a Toit program. Click Run online to execute the code in the console (as opposed to running it on a specific device which can be done in the Code tab). The playground uses the latest firmware version.
Users lists all users in the organization, starting with the current user. Click on Add User to add new users to the organization by simply entering their email address. A welcome email is sent to the newly created user, with a link to set the password for the new Toit account just created.
Details is used to enter your Organization information and payment methods. It also indicates how many hardware keys are available in your organization to be used when provisioning new devices.
Firmware lists all firmware versions available to your organization. A pie chart depicts the distribution of the different firmware versions installed on the devices of your organization.
Data Usage displays data and graphs that give full transparency on your data usage type (application or system data, such as logs and metrics), as well as usage history and forecast, so you always can predict your upcoming bill with Toit.
Invoices lists previously paid invoices, if any.
API keys lists the keys that can be used to connect a server application to the API.
The System page displays various graphs showing information about metrics, data, logs and PubSub ingestion in the system.
The Data page allows to create metrics and logs subscriptions with the Create subscription button. Existing subscription are listed on the page and can be deleted with the bin icon. Selected an existing subscription from the drop down menu in one of the graph to visualize Unacknowledged message count and Oldest unacknowledged message age data for the chosen time interval. Check the API documentation to learn how to acknowledge messages using the CLI.
Note that while it is also possible to create app data subscriptions on the Data page, it is recommended to use the PubSub page for these instead. Subscriptions allow for bi-directional support, as opposed to app data subscriptions on the Data page that only compile messages coming from the device.
Use this page to create custom subscriptions and access subscription-specific data on Unacknowledged message count and Oldest unacknowledged message age. See the PubSub section for more information.
Use this tab to download the Toit CLI, as well as SDK examples and the Toit library.