Edge device registered on the platform.
Attributes
| Name | Type | Description |
|---|---|---|
| edge_device_id | uuid.UUID | technical id of the edge device. |
| device_id | str | logical device identifier string. |
| name | str | display name of the edge device. |
| twin_name | str | name of the associated twin. |
| twin_id | uuid.UUID | technical id of the associated twin. |
| status | EdgeDeviceStatus | current status of the device. |
| status_code | int | numeric status code. |
| device_type | EdgeDeviceType | type of the edge device. |
| connection_state | str | IoT Hub connection state ('Connected' or 'Disconnected'), enriched from IoT Hub. |
| last_activity_time | str | last device activity timestamp from IoT Hub. |
Methods
api_id()
return current object id on Web API format.
api_key()
return current object logical unique key (e.g. hardware_id, key, name).
returns None if the entity has no logical key.
endpoint()
return endpoint name used to contact backend.
from_json()
load the object from a dict originating of a JSON format.
| Name | Type | Default | Description |
|---|---|---|---|
| obj | object to load information from. |
set_id()
specify the id_value neutrally
| Name | Type | Default | Description |
|---|---|---|---|
| id_value | |||
| return: |
to_json()
transform current object into a dict that could be JSONIFY.
| Name | Type | Default | Description |
|---|---|---|---|
| target | str | None | |
| return: dumpable dict. |