Skip to content

Device Settings

Sam Spencer edited this page Oct 16, 2023 · 2 revisions

Schema Docs

Type object
Required No
Additional properties [Not allowed]
Property Pattern Type Deprecated Definition Title/Description
- deviceSettings No object No - Device Settings

1. Property root > deviceSettings

Title: Device Settings

Type object
Required No
Additional properties [Not allowed]

Description: Device information which can be accessed via a CHCK command. READ ONLY

Property Pattern Type Deprecated Definition Title/Description
+ deviceModel No enum (of string) No - Device Model
+ firmwareVersion No string No - Firmware Version
+ hardwareVersion No string No - Hardware Version
+ uId No integer No - UID
+ deviceName No string No - Device Name
+ profileId No integer No - Profile ID

1.1. Property root > deviceSettings > deviceModel

Title: Device Model

Type enum (of string)
Required Yes

Must be one of:

  • "Bridge4"
  • "Bridge6"

1.2. Property root > deviceSettings > firmwareVersion

Title: Firmware Version

Type string
Required Yes

1.3. Property root > deviceSettings > hardwareVersion

Title: Hardware Version

Type string
Required Yes

1.4. Property root > deviceSettings > uId

Title: UID

Type integer
Required Yes

Description: 96-bit unique identifing number for each device. Can be used to identify multiple devices with the same name

Restrictions
Minimum ≥ 0

1.5. Property root > deviceSettings > deviceName

Title: Device Name

Type string
Required Yes

Description: User assignable name for the device

Restrictions
Max length 16

1.6. Property root > deviceSettings > profileId

Title: Profile ID

Type integer
Required Yes
Default 0

Description: Tracks changes to the device configuration across the editor and on-board. If a different value is retrieved compared to the previous stored value, it can be assumed that configuration changes were performed externally of the editor.

Restrictions
Minimum ≥ 0
Maximum ≤ 4294967295

Generated using json-schema-for-humans on 2023-10-16 at 12:51:30 +1100