Provisioning

Provisioning is a process of adding devices to the Enapter Platform.

Reprovisioning

Sometimes, you may need to reprovision the same device to the same site, such as when the Wi-Fi SSID changes. Reprovisioning requires the same arguments as regular provisioning, but it does not create a new device.

note

You can not reprovision Lua device.

Provision UCM

POST provisioning/ucm

Adds a UCM (Universal Communication Module) to the Enapter Platform.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/ucm \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "C8795CBA5375484E829105E959663C8B",
            "name": "My UCM",
            "protocol": "MQTTS"
        }'

site_idstring#: ID of the site.

hardware_idstring#: Device hardware ID.

namestring#: Device name.

protocolstring#: MQTT or MQTTS.

Response

{
    "config": {
        "mqtt_host": "mqtt.enapter.com",
        "mqtt_port": 8883,
        "mqtt_credentials": {
            "protocol": "MQTTS",
            "private_key": "...",
            "certificate": "...",
            "ca_chain": "..."
        },
        "time_sync_protocol": "HTTP",
        "time_sync_host": "127.0.0.1",
        "time_sync_port": 80,
        "hardware_id": "C8795CBA5375484E829105E959663C8B",
        "channel_id": "ucm"
    },
    "device_id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b",
    "slug": "my-ucm"
}

config.mqtt_hoststring#: Enapter Cloud MQTT broker host.

config.mqtt_postinteger#: Enapter Cloud MQTT broker port.

config.mqtt_credentialsobject#: Contains either MQTT or MQTTS credentials.

config.mqtt_credentials.protocolstring#: MQTT or MQTTS.

MQTT	MQTTS
`config.mqtt_credentials.username`string# Enapter Cloud MQTT broker username.	`config.mqtt_credentials.private_key`string# Enapter Cloud MQTT broker private key.
`config.mqtt_credentials.password`string# Enapter Cloud MQTT broker password.	`config.mqtt_credentials.certificate`string# Enapter Cloud MQTT broker certificate.
	`config.mqtt_credentials.ca_chain`string# Enapter Cloud MQTT broker certificate chain.

config.time_sync_protocolstring#: Time synchronization protocol.

config.time_sync_hoststring#: Time synchronization host.

config.time_sync_portinteger#: Time synchronisation server port.

config.hardware_idstring#: Device hardware ID.

config.channel_idstring#: Device channel ID.

device_idstring#: Device ID.

slugstring#: Device's slug.

Provision VUCM

POST provisioning/vucm

Adds a virtual UCM (Universal Communication Module) to the Enapter Platform.

Gateway only

You can add a virtual UCM only on Gateway 3.x.x.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/vucm \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "V8795CBA5375484E829105E959663C8B",
            "name": "My VUCM"
        }'

site_idstring#: ID of the site.

hardware_idstring#: Device hardware ID.

namestring#: Device name.

Response

{
    "device_id": "fecbbba0-79f2-4e9e-a6f0-69a310ab110b"
}

device_idstring#: Device ID.

Provision Enapter Device

POST provisioning/embedded

Adds an Enapter Electrolyser, Dryer or Water Tank to the Enapter Platform.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/embedded \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "device_type": "ELECTROLYSER",
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "BCC415CBA5375484E829105E959663C8B",
            "name": "My Electrolyser",
            "protocol": "MQTTS"
        }'

device_typestring#

One of the following types:

ELECTROLYSER - Enapter Electrolyser,
DRYER - Enapter Dryer,
WATER_TANK- Enapter Water Tank.

site_idstring#: ID of the site.

hardware_idstring#: Device hardware ID.

namestring#: Device name.

protocolstring#: MQTT or MQTTS.

Response

{
    "config": {
        "mqtt_host": "mqtt.enapter.com",
        "mqtt_port": 8883,
        "mqtt_credentials": {
            "protocol": "MQTTS",
            "private_key": "...",
            "certificate": "...",
            "ca_chain": "..."
        },
        "time_sync_protocol": "HTTP",
        "time_sync_host": "127.0.0.1",
        "time_sync_port": 80,
        "hardware_id": "BCC415CBA5375484E829105E959663C8B",
        "channel_id": "ucm"
    },
    "device_id": "elebbba0-79f2-4e9e-a6f0-69a310ab110b",
    "slug": "my-electrolyser"
}

config.mqtt_hoststring#: Enapter Cloud MQTT broker host.

config.mqtt_postinteger#: Enapter Cloud MQTT broker port.

config.mqtt_credentialsobject#: Contains either MQTT or MQTTS credentials.

config.mqtt_credentials.protocolstring#: MQTT or MQTTS.

MQTT	MQTTS
`config.mqtt_credentials.username`string# Enapter Cloud MQTT broker username.	`config.mqtt_credentials.private_key`string# Enapter Cloud MQTT broker private key.
`config.mqtt_credentials.password`string# Enapter Cloud MQTT broker password.	`config.mqtt_credentials.certificate`string# Enapter Cloud MQTT broker certificate.
	`config.mqtt_credentials.ca_chain`string# Enapter Cloud MQTT broker certificate chain.

config.time_sync_protocolstring#: Time synchronization protocol.

config.time_sync_hoststring#: Time synchronization host.

config.time_sync_portinteger#: Time synchronisation server port.

config.hardware_idstring#: Device hardware ID.

config.channel_idstring#: Device channel ID.

device_idstring#: Device ID.

slugstring#: Device's slug.

Provision Master UCM Link

POST provisioning/link_master

Adds a master Enapter LINK device to the Enapter Platform.

Gateway only

You can connect an Enapter LINK device only to the Gateway 3.x.x.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/embedded \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "BCC415CBA5375484E829105E959663C8B",
            "name": "Enapter Link 1"
        }'

site_idstring#: ID of the site.

hardware_idstring#: Device hardware ID.

namestring#: Device name.

Response

{
    "device_id": "02618484-5c16-4159-998a-ef4acc16666c"
}

device_idstring#: Device ID.

Provision Slave UCM Link

Adds a slave Enapter LINK device to the Enapter Platform.

POST provisioning/link_slave

Gateway only

You can connect an Enapter LINK device only to the Gateway 3.x.x.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/embedded \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "435840FFE5CD4E9DA93545DDF7E6D5FB",
            "name": "ENP-AO6 BCC4",
            "master_device_id": "02618484-5c16-4159-998a-ef4acc16666c"
        }'

device_idstring#: Enapter LINK master device ID.

Response

{
    "device_id": "5841fafa-8d10-4103-ba7c-1b818899270f"
}

device_idstring#: Device ID.

Provision Standalone Device

POST provisioning/standalone

Adds a Enapter Standalone device to the Enapter Platform.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/standalone \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "sitebba0-79f2-4e9e-a6f0-69a310ab110b",
            "name": "My Device"
        }'

site_idstring#: ID of the site.

namestring#: Device name.

Response

{
    "device_id": "standba0-79f2-4e9e-a6f0-69a310ab110b",
    "slug": "my-device"
}

device_idstring#: Device ID.

slugstring#: Device's slug.

Provision Lua Device

POST provisioning/lua_device

Adds a Lua device that implements integration with third-party devices using Lua scripts.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/standalone \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "runtime_id": "ucmbbba0-79f2-4e9e-a6f0-69a310ab110b",
            "blueprint_id": "bluepri1-50n3-4t9d-e6v0-69i310cb110e",
            "name": "Gas sensor",
            "slug": "gas-sensor-1"
        }'

runtime_idstring#: Runtime device ID.

blueprint_idstring#: Device blueprint ID.

namestring#: Device name.

slugstring#: Device slug.

Response

{
    "device_id": "devicea0-45f2-4e9e-a6f0-69a310ab110b",
    "slug": "gas-sensor-1"
}

device_idstring#: Device ID.

slugstring#: Device's slug.

Provision Gateway

POST provisioning/gateway

Cloud only

You can provision Gateway only to the Enapter Cloud.

Request

$ curl -X POST \
    http://api.enapter.com/v3/provisioning/gateway \
    -H 'X-Enapter-Auth-Token: {ACCESS_TOKEN}' \
    -d '{
            "site_id": "fecbbba0-79f2-4e9e-a6f0-69a310ab110b",
            "hardware_id": "B27925CBA5375484E829105E959663C8B",
            "gateway_version": "3.0.0",
            "site_name": "My Site",
            "site_timezone": "Europe/Berlin",
            "site_location": {
                "latitude": 52.520008,
                "longitude": 13.404954
            }
        }'

Body Parameters

site_idstring#: ID of the site, to which you want add an Enapter Gateway.

hardware_idstring#: Enapter Gateway hardware ID.

gateway_versionstring#: Enapter Gateway firmware version.

site_namestring#: Name of the site.

site_timezonestring#: Timezone of the site.

site_location.latitudestring#: Location latitude of the site.

site_location.longitudestring#: Location longitude of the site.

Response

{
    "config": {
        "mqtt_host": "mqtt.enapter.com",
        "mqtt_port": 8883,
        "mqtt_credentials": {
            "protocol": "MQTTS",
            "private_key": "...",
            "certificate": "...",
            "ca_chain": "..."
        },
        "time_sync_protocol": "HTTP",
        "time_sync_host": "127.0.0.1",
        "time_sync_port": 80,
        "hardware_id": "FGC415CBA5375484E829105E959663C8B",
        "channel_id": "gw"
    },
    "gateway_device_id": "gwcbbba6-79f2-4e9e-a6f0-69a310ab110b"
}

config.mqtt_hoststring#: Enapter Cloud MQTT broker host.

config.mqtt_postinteger#: Enapter Cloud MQTT broker port.

config.mqtt_credentialsobject#: Contains either MQTT or MQTTS credentials.

config.mqtt_credentials.protocolstring#: MQTT or MQTTS.

MQTT	MQTTS
`config.mqtt_credentials.username`string# Enapter Cloud MQTT broker username.	`config.mqtt_credentials.private_key`string# Enapter Cloud MQTT broker private key.
`config.mqtt_credentials.password`string# Enapter Cloud MQTT broker password.	`config.mqtt_credentials.certificate`string# Enapter Cloud MQTT broker certificate.
	`config.mqtt_credentials.ca_chain`string# Enapter Cloud MQTT broker certificate chain.

config.time_sync_protocolstring#: Time synchronization protocol.

config.time_sync_hoststring#: Time synchronization host.

config.time_sync_portinteger#: Time synchronisation server port.

config.hardware_idstring#: Device hardware ID.

config.channel_idstring#: Device channel ID.

gateway_device_idstring#: Device ID of newly added Enapter Gateway.

Reprovisioning​

Provision UCM​

Request​

site_idstring#

hardware_idstring#

namestring#

protocolstring#

Response​

config.mqtt_hoststring#

config.mqtt_postinteger#

config.mqtt_credentialsobject#

config.mqtt_credentials.protocolstring#

config.mqtt_credentials.usernamestring#

config.mqtt_credentials.private_keystring#

config.mqtt_credentials.passwordstring#

config.mqtt_credentials.certificatestring#

config.mqtt_credentials.ca_chainstring#

config.time_sync_protocolstring#

config.time_sync_hoststring#

config.time_sync_portinteger#

config.hardware_idstring#

config.channel_idstring#

device_idstring#

slugstring#

Provision VUCM​

Request​

site_idstring#

hardware_idstring#

namestring#

Response​

device_idstring#

Provision Enapter Device​

Request​

device_typestring#

site_idstring#

hardware_idstring#

namestring#

protocolstring#

Response​

config.mqtt_hoststring#

config.mqtt_postinteger#

config.mqtt_credentialsobject#

config.mqtt_credentials.protocolstring#

config.mqtt_credentials.usernamestring#

config.mqtt_credentials.private_keystring#

config.mqtt_credentials.passwordstring#

config.mqtt_credentials.certificatestring#

config.mqtt_credentials.ca_chainstring#

config.time_sync_protocolstring#

config.time_sync_hoststring#

config.time_sync_portinteger#

config.hardware_idstring#

config.channel_idstring#

device_idstring#

slugstring#

Provision Master UCM Link​

Request​

site_idstring#

hardware_idstring#

namestring#

Response​

device_idstring#

Provision Slave UCM Link​

Request​

device_idstring#

Response​

device_idstring#

Provision Standalone Device​

Request​

site_idstring#

namestring#

Response​

device_idstring#

slugstring#

Provision Lua Device​

Request​

runtime_idstring#

blueprint_idstring#

namestring#

slugstring#

Reprovisioning

Provision UCM

Request

`site_id`string#

`hardware_id`string#

`name`string#

`protocol`string#

Response

`config.mqtt_host`string#

`config.mqtt_post`integer#

`config.mqtt_credentials`object#

`config.mqtt_credentials.protocol`string#

`config.mqtt_credentials.username`string#

`config.mqtt_credentials.private_key`string#

`config.mqtt_credentials.password`string#

`config.mqtt_credentials.certificate`string#

`config.mqtt_credentials.ca_chain`string#

`config.time_sync_protocol`string#

`config.time_sync_host`string#

`config.time_sync_port`integer#

`config.hardware_id`string#

`config.channel_id`string#

`device_id`string#

`slug`string#

Provision VUCM

Request

`site_id`string#

`hardware_id`string#

`name`string#

Response

`device_id`string#

Provision Enapter Device

Request

`device_type`string#

`site_id`string#

`hardware_id`string#

`name`string#

`protocol`string#

Response

`config.mqtt_host`string#

`config.mqtt_post`integer#

`config.mqtt_credentials`object#

`config.mqtt_credentials.protocol`string#

`config.mqtt_credentials.username`string#

`config.mqtt_credentials.private_key`string#

`config.mqtt_credentials.password`string#

`config.mqtt_credentials.certificate`string#

`config.mqtt_credentials.ca_chain`string#

`config.time_sync_protocol`string#

`config.time_sync_host`string#

`config.time_sync_port`integer#

`config.hardware_id`string#

`config.channel_id`string#

`device_id`string#

`slug`string#

Provision Master UCM Link

Request

`site_id`string#

`hardware_id`string#

`name`string#

Response

`device_id`string#

Provision Slave UCM Link

Request

`device_id`string#

Response

`device_id`string#

Provision Standalone Device

Request

`site_id`string#

`name`string#

Response

`device_id`string#

`slug`string#

Provision Lua Device

Request

`runtime_id`string#

`blueprint_id`string#

`name`string#

`slug`string#