Losant

https://docs.losant.com
Admin
Losant is an all-in-one IoT solution platform that provides tools for templating, building connected...
Tokens:1,017,641
Snippets:7,984
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run from source commands

Source: https://docs.losant.com/mcp/overview

Clones the repository, installs dependencies, copies the environment template, and starts the server. Requires Node.js and pnpm. Edit .env to set LOSANT_API_TOKEN before starting.

```bash
git clone https://github.com/Losant/losant-mcp-server.git
cd losant-mcp-server
pnpm install
cp .env.example .env
# Edit .env and set LOSANT_API_TOKEN
pnpm start
```

--------------------------------

### Instance Sandboxes Response Example

Source: https://docs.losant.com/rest-api/instance-sandboxes

Example response body for a successful GET request, showing a collection of sandboxes with pagination details.

```json
  * ▶
(root){} 7 keys
    * count:2
    * ▶
items:[] 2 items
    * limit:100
    * startingAfterId:"575ed70c7ae143cd83dc4aa9"
    * sortField:"firstName"
    * sortDirection:"asc"
    * hasMore:false


▶
```

--------------------------------

### Example Read Instructions Array

Source: https://docs.losant.com/workflows/data/opcua-read

An example array of read instructions for the Payload Path option. Each object requires nameSpace, identifier, and key properties. The identifier must start with i=, s=, g=, or b=.

```json
[
  {
    "nameSpace": 2,
    "identifier": "i=3",
    "key": "Power"
  }
]
```

--------------------------------

### Get Device by Tag - Example Result

Source: https://docs.losant.com/workflows/data/peripheral-get

Example output when querying a single device by tag `sigfox_id` with value `AA00FF` and result path set to `working.deviceResult`. Shows the device object structure including id, name, deviceClass, tags, and attributes.

```json
{

  "working": {

    "deviceResult": {

      "id": "56c794a06895b00100cbe84c",

      "name": "Sigfox Device",

      "deviceClass": "peripheral",

      "tags": {

        "sigfox_id": ["AA00FF"]

      },

      "attributes": [

        { "name": "temp", "dataType": "number" },

        { "name": "humidity", "dataType": "number" }

      ]

    }

  },

  ...

}

```

--------------------------------

### GET /me/deviceCounts - Curl Example

Source: https://docs.losant.com/rest-api/me

Curl command to retrieve device counts by day for all applications the current user owns. Requires an API access token with appropriate scopes. The start and end query parameters are optional.

```bash
curl -H 'Content-Type: application/json' \

    -H 'Accept: application/json' \

    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \

    -X GET \

    https://api.losant.com/me/deviceCounts
```

--------------------------------

### Example command with actual credentials

Source: https://docs.losant.com/guides/how-to-use-losants-embedded-edge-agent-to-calculate-FFT-values

Shows a concrete example of the command with sample device credentials. The output should show the device connecting to the Losant MQTT Broker and sending PINGREQ/PINGRES messages.

```bash
DEVICE_ID=616f38e0a48c0ed7634c2e9a ACCESS_KEY=d14e5746-a1e5-46d4-9725-cfe4c1a7645d ACCESS_SECRET=e59420f0d75873950b189680260f89937e769e52cf195e0960f7d67a457b8a57 python3 main.py  
```

--------------------------------

### Run Python example with environment variables

Source: https://docs.losant.com/edge-compute/embedded-edge-agent/walkthrough

Set DEVICE_ID, ACCESS_KEY, and ACCESS_SECRET environment variables and run python3 main.py to connect the example application to the Losant broker.

```bash
DEVICE_ID=YOUR_DEVICE_ID \
ACCESS_KEY=YOUR_ACCESS_KEY \
ACCESS_SECRET=YOUR_ACCESS_SECRET \
python3 main.py
```

--------------------------------

### Get Categories - Curl Example

Source: https://docs.losant.com/rest-api/application-templates

Curl command to retrieve a list of application template categories. Requires an API access token with appropriate scopes (e.g., applicationTemplates.getCategories). The optional baseId query parameter can be used to start from a specific category.

```bash
curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applicationTemplates/categories
```

--------------------------------

### Get Date Element - Example Input (month)

Source: https://docs.losant.com/workflow-lab/lab

Example input for the 'get-date-element' test with element 'month'.

```json
{
  "date": "2019-09-06T13:30:52.557Z",
  "element": "month"
}
```

--------------------------------

### Connect, send state, and subscribe to commands

Source: https://docs.losant.com/mqtt/python

Basic example showing how to construct a device, observe commands, connect to Losant, and send state in a loop. Requires a sensor function call_out_to_your_sensor_here() to be defined.

```python
import time  

from losantmqtt import Device  

  

# Construct device  

device = Device("my-device-id", "my-app-access-key", "my-app-access-secret")  

  

def on_command(device, command):  

    print("Command received.")  

    print(command["name"])  

    print(command["payload"])  

  

# Listen for commands.  

device.add_event_observer("command", on_command)  

  

# Connect to Losant.  

device.connect(blocking=False)  

  

# Send temperature once every second.  

while True:  

    device.loop()  

    if device.is_connected():  

        temp = call_out_to_your_sensor_here()  

        device.send_state({"temperature": temp})  

    time.sleep(1)  
```

--------------------------------

### Get Date Element - Example Input (year)

Source: https://docs.losant.com/workflow-lab/lab

Example input for the 'get-date-element' test with element 'year'.

```json
{
  "date": "2019-09-06T13:30:52.557Z",
  "element": "year"
}
```

--------------------------------

### Arduino MQTT client handleCommand example

Source: https://docs.losant.com/devices/commands

Example using the Losant Arduino MQTT client to handle a command and turn on an LED. It subscribes to commands and checks the command name.

```cpp
// Called whenever the device receives a command from the Losant Platform.
void handleCommand(LosantCommand *command) {
  Serial.print("Command received: ");
  Serial.println(command->name);
  if(strcmp(command->name, "turn-on-led") == 0) {
    digitalWrite(LED_PIN, 1);
  }
}

LosantDevice device("my-device-id");
device.connectSecure(wifiClient, "my-access-key", "my-access-secret");

// Subscribe to commands.
device.onCommand(&handleCommand);
```

--------------------------------

### Get Date Element - Example Input

Source: https://docs.losant.com/workflow-lab/lab

Example input for the 'get-date-element' test. Provides a date and the element to parse (e.g., 'day', 'year', 'month').

```json
{
  "date": "2099-05-26T11:36:47.206Z",
  "element": "day"
}
```

--------------------------------

### Run main.py with device credentials

Source: https://docs.losant.com/guides/how-to-use-losants-embedded-edge-agent-to-calculate-FFT-values

Command to run the EEA example, connecting the Raspberry Pi to Losant as an Embedded Device. Replace placeholders with actual device ID, access key, and access secret.

```bash
DEVICE_ID=<embedded device id> ACCESS_KEY=<access key> ACCESS_SECRET=<access secret> python3 main.py  
```

--------------------------------

### Example response from GET /devices

Source: https://docs.losant.com/guides/how-to-build-an-experience-api/viewing-device-data

This is the JSON response returned by the GET /devices endpoint. It contains an array of device objects, each with name, tags, attributes, and id fields.

```json
[
  {
    "name": "My Awesome Plant",
    "tags": {
      "owner": [
        "58e016591c3ce300017cc5d4"
      ],
      "manufacturerId": [
        "000000"
      ]
    },
    "attributes": [
      {
        "name": "moisture",
        "dataType": "number"
      }
    ],
    "id": "58e4605f29eeec0001d383df"
    ...
  }
]
```

--------------------------------

### Run GEA Docker container (quick start)

Source: https://docs.losant.com/edge-compute/gateway-edge-agent/usage

Minimum command to start the GEA. Assumes Docker can be run without sudo or as root. Use during evaluation; production deployments should consider additional configuration options.

```bash
docker run --restart=always -d \
  -e "DEVICE_ID=YOUR_DEVICE_ID" \
  -e "ACCESS_KEY=YOUR_ACCESS_KEY" \
  -e "ACCESS_SECRET=YOUR_ACCESS_SECRET" \
  losant/edge-agent
```

--------------------------------

### Connect, send state, and subscribe to commands with losant-mqtt

Source: https://docs.losant.com/mqtt/javascript

Basic example showing how to construct a device with your Losant credentials, connect to Losant, listen for commands, and send state every second. Requires a device ID, application access key, and application access secret.

```javascript
var Device = require('losant-mqtt').Device

// Construct device
var device = new Device({
  id: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret',
})

// Connect to Losant.
device.connect()

// Listen for commands.
device.on('command', function(command) {
  console.log('Command received.')
  console.log(command.name)
  console.log(command.payload)
})

// Send temperature once every second.
setInterval(function() {
  device.sendState({ temperature: readAnalogIn() })
}, 1000)
```

--------------------------------

### GET /me/notebookMinuteCounts - Curl Example

Source: https://docs.losant.com/rest-api/me

Returns notebook execution usage by day for the specified time range for all applications the current user owns. Requires an API access token with the appropriate scopes. Optional query parameters 'start' and 'end' (ms since epoch) can be provided. Successful response is 200 with notebook usage information; 400 error if malformed.

```bash
curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/me/notebookMinuteCounts
```

--------------------------------

### Example Read Instructions Array for Modbus Read Node

Source: https://docs.losant.com/workflows/data/modbus-read

An example array of Read Instructions to pass via the Payload Path. This example reads three holding registers starting at address 8 and stores the result under the key 'holdRegResults'.

```json
[
  {
    "type": "holding-register",
    "address": 8,
    "length": 3,
    "key": "holdRegResults"
  }
]
```

--------------------------------

### Example device JSON before update

Source: https://docs.losant.com/workflows/data/device-update

Shows the initial state of a device object used in the example. It includes name, deviceClass, tags, and attributes.

```json
{

  "name": "My Device",

  "deviceClass": "standalone",

  "tags": [{ "key": "myTagKey", "value": "My Tag Value" }],

  "attributes": [{ "name": "myNumberAttribute", "dataType": "number" }]

}
```

--------------------------------

### Instances Example

Source: https://docs.losant.com/rest-api/instances

Example of an Instances response, showing a collection with two items and pagination details.

```json
  * ▶
(root){} 7 keys
    * count:2
    * ▶
items:[] 1 item
    * perPage:100
    * page:0
    * sortField:"name"
    * sortDirection:"asc"
    * totalCount:2


▶
```

--------------------------------

### Verify Docker installation with hello-world

Source: https://docs.losant.com/edge-compute/gateway-edge-agent/installation

Runs the hello-world container to verify Docker is installed correctly. A successful run outputs 'Hello from Docker'.

```bash
docker run hello-world
```

--------------------------------

### Application Job Log Example

Source: https://docs.losant.com/rest-api/application-job-log

Example of an Application Job Log object, showing a sample response with fields like id, jobId, ownerId, status, and name. This illustrates the structure of a successful GET response.

```json
  * ▶
(root){} 9 keys
    * id:"575ec76c7ae143cd83dc4a96"
    * jobId:"575ec76c7ae143cd83dc4a96"
    * ownerId:"575ec8687ae143cd83dc4a97"
    * ownerType:"application"
    * runQueuedAt:"2025-06-10T04:00:00.000Z"
    * runStartedAt:"2025-06-10T04:00:01.000Z"
    * status:"inProgress"
    * name:"ArchiveData"
    * ▶
progress:{} 2 keys


▶
```

--------------------------------

### Example Command Subscription

Source: https://docs.losant.com/mqtt/overview

Example of a command to set a thermostat temperature. The device listens on the topic for command messages.

```text
losant/575ecf887ae143cd83dc4aa2/command
```

```json
{
  "name": "set-temperature",
  "payload": {
    "temperature": 72
  }
}
```

--------------------------------

### Example GEA MQTT Broker Configuration File

Source: https://docs.losant.com/edge-compute/gateway-edge-agent/local-broker

Example configuration file for the Gateway Edge Agent's local MQTT broker. Shows commented-out settings for enabling the broker, setting the port, address, username, and password. The broker is disabled by default.

```ini
#...  

[localBroker]  

# If the local MQTT broker should be enabled - CLI: --local-broker-enabled, EnvVar: LOCAL_BROKER_ENABLED  
# enabled = false  

  

# Port to run the local MQTT broker on - CLI: --local-broker-port, EnvVar: LOCAL_BROKER_PORT  
# port = 1883  

  

# Address to run the local MQTT broker on - CLI: --local-broker-address, EnvVar: LOCAL_BROKER_ADDRESS  
# address = '0.0.0.0'  

  

# Username for the local MQTT broker - CLI: --local-broker-username, EnvVar: LOCAL_BROKER_USERNAME  
# username = ''  

  

# Password for the local MQTT broker - CLI: --local-broker-password, EnvVar: LOCAL_BROKER_PASSWORD  
# password = ''  

```

--------------------------------

### Get Date Element - Example Output (month)

Source: https://docs.losant.com/workflow-lab/lab

Expected output for the 'get-date-element' test when parsing the month element.

```json
{
  "result": "9"
}
```

--------------------------------

### Get Date Element - Example Output (year)

Source: https://docs.losant.com/workflow-lab/lab

Expected output for the 'get-date-element' test when parsing the year element.

```json
{
  "result": "2019"
}
```

--------------------------------

### Start the Embedded Device with environment variables

Source: https://docs.losant.com/guides/how-to-use-losants-embedded-edge-agent-to-calculate-FFT-values

Run this command to start the device with your embedded device ID, access key, and access secret.

```bash
DEVICE_ID=<embedded device id> ACCESS_KEY=<access key> ACCESS_SECRET=<access secret> python3 main.py  

```

--------------------------------

### Get Date Element - Example Output (day)

Source: https://docs.losant.com/workflow-lab/lab

Expected output for the 'get-date-element' test when parsing the day element.

```json
{
  "result": "5"
}
```
Tokens:
Raw