device_resp_object

deviceobject

Device object containing device information.

Device.idstring

Device ID.

Device.blueprint_idstring

Blueprint ID.

Device.site_idstring

Site ID.

Device.namestring

Device name.

Device.updated_atstring

The latest update time of the device in RFC 3339 format.

Device.authorized_rolestring

The user's authorized role for the device.

Device.slugstring

Device slug.

Device.typestring

One of the following types:

• STANDALONE – device that operates independently without needing to be connected to a Gateway or other Enapter hardware.
• GATEWAY – device that connects Enapter energy systems to the Enapter Cloud for data communication, remote monitoring and control.
• EMBEDDED_UCM – communication module, which embedded into Enapter devices UCM,
• HARDWARE_UCM – Enapter Universal Communication Module (UCM),
• VIRTUAL_UCM – Enapter virtual UCM,
• LINK_MASTER_UCM, – Enapter LINK master device,
• LINK_SLAVE_UCM – Enapter UCM, connected to Enapter LINK master device,
• LUA – a third-party device, which connected to Enapter UCM and controlled by a Lua script,
• NATIVE – Enapter device like Electrolyser or Dryer.

Device.implemented_profilesarray of strings

A list of profiles implemented by the device. You can also find them in the device's manifest.

Expanded fields

Expanded fields are included in the response only if you specify them in the expand query parameter.

Device.propertiesobject

Device properties.

Device.manifestobject

Device manifest.

Device.communicationobject

DeviceCommunication object represents device's communication info.

Communication.typestring

A type of communication to the Enapter EMS:

• MQTT_V1_PLAINTEXT – unencrypted MQTT connection;
• MQTT_V1_TLS – encrypted MQTT connection (MQTTS);
• MQTT_V1_LOCALHOST – connected to a local MQTT server;
• UCM_LUA – connected to Enapter UCM, hardware or virtual;
• UCM_EMBEDDED – via embedded UCM;
• LINK – via Enapter LINK.

Communication.upstream_idstring

Device ID of upstream device. Will be omited for devices connected to MQTT brocker directly

Communication.hardware_idstring

Device communication hardware ID. Will be set for devices connected to MQTT brocker directly.

Communication.channel_idstring

Device communication channel ID. Will be set for devices connected to MQTT brocker directly.

Device.siteobject

siteobject

Site object contains site information.

Site.idstring

ID of the site.

Site.namestring

Name of the site.

Site.timezonestring

Timezone of the site.

Site.locationobject

The site location information.

location.namestring

Location name of the site.

location.latitudestring

Location latitude of the site.

location.longitudestring

Location longitude of the site.

Site.authorized_rolestring

User authorized role for the site. See authorization system for more details.

Site.versionstring

Version of the site. Should be always V3 at now.

Device.connectivityobject

Device connectivity information.

connectivity.statusstring

Connectivity status. Can be ONLINE or OFFLINE.