Skip to content

Get started#

Learn the basics of using Toit to get started building your own IoT apps, monitoring your device fleet, easily upgrading device firmware and apps over-the-air, and pulling device data via our external APIs into your own cloud or IoT application.

By guiding you through the initial steps, we'll show you how easy it is to develop IoT apps with Toit, enabling you with more time on focusing building innovative IoT applications, while we'll take care of the rest.

1. Sign up#

Create a free Toit account to get access to the Toit cloud. Go to toit.io and follow the sign-up instructions.

Shortly after, you'll receive a welcome email with a link to set the password for your Toit account. You will be redirected to the login page from where you can log in to the Toit console.

2. Install Toit#

Navigate to the download page in order to download the Toit CLI, which is used when preparing your ESP32 with Toit.

Follow the download instructions here.

3A. Get an ESP32#

If you don't have an ESP32 you can buy one here.

In the meantime, use the playground or a simulated device to continue learning about the Toit platform.

Provision ESP32#

When you have an ESP32 ready for the Toit platform, you must provision the ESP32 initially using the Toit CLI as described in the provisioning section.

As a start, add WiFi connection credentials to the ESP32 for a WiFi that is currently available during the initial provisioning steps. Afterwards, you can add other connection types to the device, for example setup a cellular connection on the device.

Before you can access the ESP32, it must be claimed into your organization in the Toit console. Follow the steps described in the claiming section.

3B. Start simulator#

If you don't have an ESP32 yet, use the Playground to write IoT applications in the Toit language or use a simulated device to run or deploy Toit apps on.

Start a new Toit simulator from the Toit console by clicking the "Start simulator" button, or run the following command in the Toit CLI:

toit simulator start --alias MyToitDevice

4. Get Toit examples#

Download Toit sample code and save it in a folder named toit-examples with the CLI command:

toit sdk examples toit-examples

The content of the examples folder will be used in the next steps when running a Toit program on your device.

5. Run Toit program#

Running a program on an online device means that the Toit code runs once and is removed from the device when it terminates.

Run the Toit program hello.toit on your device using the CLI command: 

toit run -d MyToitDevice toit-examples/examples_v1.0.2/hello/hello.toit

If you have an ESP32 with Toit, replace the device name MyToitDevice with the name of your ESP32.

You can also run a Toit program from the Code tab of the device in the Toit console.

6. Deploy Toit app#

Deploying an IoT app on your device means that the Toit code will be executed repeatedly according to the scheduling defined in the app specification file provided.

Deploy a Toit app on your device by deploying the app specification file hello.yaml:

toit deploy -d MyToitDevice toit-examples/examples_v1.0.2/hello/hello.yaml

When deploying an app, the device is not required to be online. The app will be installed on the device when it comes online again.

If you have an ESP32 with Toit, replace the device name MyToitDevice with the name of your ESP32.

The content and structure of the specification file for a Toit app is described here.

7. Data usage and payment#

To begin with, there is a limit on how many devices you can provision with Toit. Currently, the limit is 10 devices. Please, contact us if you need to provision more devices.

If your devices generate more data than the limit on 100MB of free data per month, submit your payment information here to get access to the full version of the Toit platform.

Monitor the data usage for the entire organization here.