Writing an Enapter Blueprint

The new standalone device has no useful blueprint assigned. You need to write a blueprint that describes your device capabilities: telemetry, properties, and commands. The complete reference for Enapter Blueprint is here.

Create a blueprint

Create a folder for your device, e.g. my_device. Save the following example manifest.yml into this folder:

blueprint_spec: device/3.0
display_name: Standalone Test Device

runtime:
  type: embedded

properties:
  vendor:
    display_name: Vendor
    type: string
  fw_ver:
    display_name: Firmware Version
    type: string

telemetry:
  temperature:
    display_name: Temperature
    type: float
    unit: Cel
  pressure:
    display_name: Pressure
    type: float
    unit: bar{gauge}

command_groups:
  management:
    display_name: Management

commands:
  set_power:
    display_name: Set Power
    group: management
    arguments:
      power:
        display_name: Power
        type: float
        required: true
    response:
      new_power:
        display_name: New Power
        type: float
        required: true

Change blueprint

Assign the blueprint you have just created.

ENAPTER3_API_TOKEN="<your API token>" \
enapter3 device change-blueprint \
--device-id "my-standalone-device" \
--blueprint-path my_device