Drivers¶

Driver Data Structure¶

A driver is a structural component that connects to internal or external services, providing connectivity to sources like LoRa Network Servers.

In responses, a driver looks like this:

{
  "vendor_url": "https://zenner-iot.com",
  "vendor_name": "Zenner IoT Solutions",
  "url": "https://zenner-iot.com",
  "name": "HTTP Poll",
  "meta": {},
  "driver": "Platform.Drivers.HttpPoll",
  "description": "Polls the specified URL for data and uses the HTTP body as payload for packets."
}

Key	Example	Description
`name`	`HTTP Poll`	Name of the driver.
`driver`	`Platform.Drivers.HttpPoll`	Name of the module representing the driver on the platform.
`vendor_name`	`Zenner IoT Solutions`	Name of the vendor providing the service that is being connected to
`vendor_url`	`https://zenner-iot.com`	URL of the vendor providing the service that is being connected to
`url`	`https://zenner-iot.com`	URL of the service that is being connected to
`meta`	`{}`	Additional information in JSON form
`description`	`Polls the specified URL …`	Description text for the driver

List all Drivers¶

Method: GET, Endpoint: /drivers

Example Request¶

GET https://element-iot.com/api/v1/drivers?auth=46cb688e2c0b468e26e914235d4b73ea

Example Response¶

{
  "status": 200,
  "ok": true,
  "body": [
    // Contains an array of drivers
  ]
}

This endpoint returns a list of drivers.

Show a single Driver¶

Method: GET, Endpoint: /drivers/:driver_id

Example Request¶

GET https://element-iot.com/api/v1/drivers/active-sensors-humidity-pro?auth=46cb688e2c0b468e26e914235d4b73ea

Example Response¶

{
  "status": 200,
  "ok": true,
  "body": {
    // Contains the driver
  }
}

The driver ID must be the id of the driver.