Device attributes

Get device attributes

Gets a list of device attributes for the selected device. This is used to view the device's current configuration.

Request

https://api.edenic.io/api/v1/device-attribute/{deviceId}

Query parameters

keys string optional

A comma-separated list of attribute keys e.g. setting.ph_low_alarm,setting.ph_high_alarm.

Response

[
  {
    "lastUpdateTs": 1689398954522,
    "key": "alarm.ph_low_alarm",
    "value": false
  },
  {
    "lastUpdateTs": 1681544811367,
    "key": "setting.device_name",
    "value": {
        "conflicts": [],
        "correlationId": "12345678-1234-1234-1234-123456789012",
        "originator": "APP",
        "status": "SUCCESS",
        "userId": "12345678-1234-1234-1234-123456789012",
        "value": "My Controller"
    }
  },
  ...
]

Response values

lastUpdateTs bigint

The time (in milliseconds since epoch) when the value was last updated.

key string

The key of the attribute.

value any

For alarms this is either true or false, but for settings it is a JSON object with a nested value.

value.conflicts Array<string>

Used for when the device has changes that conflict with server changes and will include the correlationId of the conflicting change.

value.correlationId string

A random UUID generated for the change. Used when conflicts occur.

value.originator string

Where the change originated.

Values: DEVICE or APP.

value.status string

Whether the change was completed successfully.

Values: SUCCESS, PENDING, FAILURE or CONFLICT.

value.userId string

The UUID of the user that made the change when the originator is APP.

value.value any

The value of the setting. See Available attributes for the expected type.

Update device attributes

Updates a list of device attributes for the selected device. This is used to request an update to the device's configuration.

Request

https://api.edenic.io/api/v1/device-attribute/{deviceId}

Body

Attributes have strict validation for their values and some may need to be sent with other attributes. Multiple attributes can be updated at once, but all need to be valid before any are applied.

The body expects JSON format. The request will have to include the Content-Type: application/json header.

{
  "setting.required_ph": 6.0,
  "setting.ph_low_alarm": 5.0,
  "setting.ph_high_alarm": 7.0
}

Available attributes

Available attributes for each device and the validation for each one is listed below. Only setting attributes can be updated but all these attributes can be read.

To understand more about these attribute, see Definitions.

Pro Controller

pH Controller

Guardian (Connect)

Guardian Wi-Fi

Response

You will get a 200 OK response if the attribute updates successfully.

The request will return an error if it fails to update the attributes:

{
  "error": "Validation error",
  "issues": {
      "setting.ph_low_alarm": [
        "Value must be a number",
        ...
      ],
      ...
    },
  }
}

Example

Here is an example request to update the pH alarms of a Pro Controller using cURL.

curl --include --request PATCH https://api.edenic.io/api/v1/device-attribute/12345678-1234-1234-1234-123456789012 \
  --header 'Authorization: ed_1234567890123456789012345789012345678901234567890123456789012345' \
  --header 'Content-Type: application/json' \
  --data '{
    "setting.required_ph": 6.0,
    "setting.ph_low_alarm": 5.0,
    "setting.ph_high_alarm": 7.0
  }'

Response should give a 200 OK result if successful.