GET /engine/resources/ble-room-devices
This resource lists all the BLE Room Devices that have been correctly programmed into the controller using EC-gfxProgram
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
The $expand system query option specifies the related resources to be included in line with retrieved resources.
The value passed in the parameter can be:
The $expand system query option can be used with the $levels query option, to expand recursively.
Object Name: BleRoomDevice
| Property Name | Type | Description | Method |
|---|---|---|---|
| resourceIndex | empty | This is the unique identifier of the BLE Room Device | GET POST |
| bluetoothMode | empty | This is the Bluetooth mode required for the device. Possible values are: - 0 for Disabled: Bluetooth connection is disabled and does not allow any wireless connections to the device. - 1 for Open: Bluetooth connection is open and is not authenticated with a PIN code. We recommend this option for rooms or areas that are accessible to anyone. - 2 for Commissioning: Bluetooth connection is used for commissioning the device. This option is the factory default mode (default PIN code 999995) and has short range for commissioning purposes only. - 3 for Private: Bluetooth connection is authenticated with a six (6) digit PIN code. When this mode is selected, you will be prompted to change the PIN code as the default PIN code is not allowed while using Private mode. We recommend this option for private rooms and areas. |
GET POST |
| modelType | Integer | This is the model type of the BLE Room Device. Possible values are: - 0 for Unitouch - 2 for Unitouch-H - 3 for Unitouch-CH - 4 for EC-Multi-Sensor-BLE |
GET |
| name | empty | This is the name | GET |
| roomName | empty | Description of the room or location of where the device is located. This name will appear on the UNITOUCH screen as well as in the my PERSONIFY mobile application device list. | GET POST |
| pinCode | empty | This is the Bluetooth PIN Code. If Private Bluetooth mode is enabled, the PIN code is required to wirelessly connect to the device using a smartphone or tablet. A minimum of six (6) digit PIN code which must be different that the default PIN code (999995) |
GET POST |
| subnetId | empty | This is the current subnet ID assigned to the device. | GET |
| uuid | empty | This is the universally unique identifier (UUID) to uniquely identify your your beacons’ network. A UUID is composed of 32 hexadecimal digits split into 5 groups separated by hyphens. Example : 74be2bd-47e1-5995-889b-4f0316eed60a |
GET POST |
| sunBlindGroups | empty | This a list of Sunblind Group | GET POST |
| lightGroups | empty | This is a list of Light Group | GET POST |
| spaceOwners | empty | This is the list of name of the space owners | GET POST |
Object Name: BleRoomDevices
| Property Name | Type | Description | Method |
|---|---|---|---|
| BleRoomDevices | empty | This is a list of BLERoomDevice object | POST GET |
URL Example: https://0.0.0.0/api/rest/v1/engine/resources/ble-room-devices
<?xml version="1.0" encoding="utf-8"?>
<BleRoomDevices>
<BleRoomDevice>
<ResourceIndex>1</ResourceIndex>
<SubnetId>1</SubnetId>
<Name>Room Device 1</Name>
<RoomName>MS1</RoomName>
<ModelType>100</ModelType>
<BluetoothMode>3</BluetoothMode>
<PinCode>999994</PinCode>
<SpaceOwners />
<LightGroups />
<SunBlindGroups />
</BleRoomDevice>
<BleRoomDevice>
<ResourceIndex>2</ResourceIndex>
<SubnetId>10</SubnetId>
<Name>Room Device 2</Name>
<RoomName>Lounge</RoomName>
<ModelType>0</ModelType>
<BluetoothMode>2</BluetoothMode>
<PinCode>999995</PinCode>
<SpaceOwners>
<SpaceOwner>Admin</SpaceOwner>
<SpaceOwner>Operator</SpaceOwner>
</SpaceOwners>
<LightGroups>
<LightGroup>
<Id>1</Id>
<Index>0</Index>
<Name>Group1</Name>
<DisplayName>Group1</DisplayName>
<Enabled>true</Enabled>
</LightGroup>
<LightGroup>
<Id>2</Id>
<Index>3</Index>
<Name>Group2</Name>
<DisplayName>Group2</DisplayName>
<Enabled>true</Enabled>
</LightGroup>
</LightGroups>
<SunBlindGroups>
<SunBlindGroup>
<Id>3</Id>
<Index>2</Index>
<Name>Group3</Name>
<DisplayName>Group3</DisplayName>
<Enabled>true</Enabled>
</SunBlindGroup>
<SunBlindGroup>
<Id>2</Id>
<Index>3</Index>
<Name>Group2</Name>
<DisplayName>Group2</DisplayName>
<Enabled>true</Enabled>
</SunBlindGroup>
</SunBlindGroups>
</BleRoomDevice>
<BleRoomDevice>
<ResourceIndex>3</ResourceIndex>
<SubnetId>2</SubnetId>
<Name>Room Device 2</Name>
<RoomName>Room Device 2</RoomName>
<ModelType>100</ModelType>
<BluetoothMode>3</BluetoothMode>
<PinCode>999555</PinCode>
<SpaceOwners />
<LightGroups />
<SunBlindGroups />
</BleRoomDevice>
<BleRoomDevice>
<ResourceIndex>4</ResourceIndex>
<SubnetId>3</SubnetId>
<Name>Room Device 3</Name>
<RoomName>Room Device 3</RoomName>
<ModelType>100</ModelType>
<BluetoothMode>2</BluetoothMode>
<PinCode>999995</PinCode>
<SpaceOwners />
<LightGroups />
<SunBlindGroups />
</BleRoomDevice>
</BleRoomDevices>