7. LW3 Programmers’ Reference
UCX series – User's Manual
80
Applied firmware package: v1.1.0b7 | LDC software: v2.5.4b3
7.14. OCS Port Configuration
DIFFERENCE:
Occupancy sensor-related commands are available only from FW package 1.1.0b7.
7.14.1. Querying the Input Level of an OCS Pin
Command and Response
#ocs #new
ç
GET·/V1/MEDIA/OCS/P1.InputLevel
æ
pr·/V1/MEDIA/OCS/P1.InputLevel=
<value>
Parameters
Parameter
Parameter description
Value
Value description
<value>
The input value of the OCS pin.
High
high level
Low
low level
Example
ç
GET /V1/MEDIA/OCS/P1.InputLevel
æ
pr /V1/MEDIA/OCS/P1.InputLevel=Low
7.14.2.
Set the Sensor Type
Command and Response
ç
SET·/V1/MEDIA/OCS/P1.SensorType=
<sensor_type>
æ
pw·/V1/MEDIA/OCS/P1.SensorType=
<sensor_type>
Parameters
Parameter
Parameter description
Value
Value description
<sensor_type>
It defines that the low or high
input level means the occupancy.
Active low
Occupancy status is
'Occupied' when the
input level is low.
Active high
Occupancy status is
'Occupied' when the
input level is high
(default value).
Example
ç
SET /V1/MEDIA/OCS/P1.SensorType=Active low
æ
pw /V1/MEDIA/OCS/P1.SensorType=Active low
7.14.3. Querying the Reported OCS State
Command and Response
ç
GET·/V1/MEDIA/OCS/P1.State
æ
pr·/V1/MEDIA/OCS/P1.State=
<status>
Parameters
Parameter
Parameter description
Value
Value description
<status>
It reports the occupancy
state of the room depending
on the sensor type.
Free
When the SensorType=Active high and the
Inputlevel=Low or
when SensorType=Active low and Inputlevel=High
Occupied
When the SensorType=Active high and the
Inputlevel=High or
when SensorType=Active low and Inputlevel=Low
Example
ç
GET /V1/MEDIA/OCS/P1.State
æ
pr /V1/MEDIA/OCS/P1.State=Free