You can use InputConfig to set up the device’s Supervised input, Aux input, etc.

Config

Set up supervised and aux inputs.

message SupervisedInputRange {
  uint32 MinValue;
  uint32 MaxValue;
}
MinValue
Minimum voltage which has a range from 0 ~ 3300(3.3v).
MaxValue
Maximum voltage which has a range from 0 ~ 3300(3.3v).
message SupervisedInputConfig {
  SupervisedInputRange short;
  SupervisedInputRange open;
  SupervisedInputRange on;
  SupervisedInputRange off;
}
short
Range of the voltage which will be distinguished as short input.
open
Range of the voltage which will be distinguished as open input.
on
Range of the voltage which will be distinguished as on input.
off
Range of the voltage which will be distinguished as off input.
enum SupervisedResistanceValue {
  SUPERVISED_REG_1K = 0;
  SUPERVISED_REG_2_2K = 1;
  SUPERVISED_REG_4_7K = 2;
  SUPERVISED_REG_10K = 3;

  SUPERVISED_REG_UNUSED = 254;
  SUPERVISED_REG_CUSTOM = 255;
}
SUPERVISED_REG_1K
1k resistance
SUPERVISED_REG_2_2K
2.2k resistance
SUPERVISED_REG_4_7K
4.7k resistance
SUPERVISED_REG_10K
10k resistance
SUPERVISED_REG_UNUSED
Unsupervised
SUPERVISED_REG_CUSTOM
Custom
message SupervisedInput {
  uint32 portIndex;
  device.SwitchType type;
  uint32 duration;
  SupervisedResistanceValue resistance;
  SupervisedInputConfig config;
}
portIndex
Input Port Number
type
Input Signal Type.
duration
Input Signal Duration Time Measurement is milliseconds(ms).
resistance
You can set Supervised input resistance value type or unsupervise it.
config
Configuration that distinguishes the supervised input signal type. This configuration will be valid only when the supervised input’s resistance is set as SUPERVISED_REG_CUSTOM.
enum AuxInputPort {
  AUX_INPUT_PORT_NORMAL = 0;
  AUX_INPUT_PORT_0 = 1;
  AUX_INPUT_PORT_1 = 2;
  AUX_INPUT_PORT_2 = 3;
}
AUX_INPUT_PORT_NORMAL
Disable aux input. (Used as normal input)
AUX_INPUT_PORT_0
Aux input port 0
AUX_INPUT_PORT_1
Aux input port 1
AUX_INPUT_PORT_2
Aux input port 2
message AuxInput {
  AuxInputPort acFail;
  device.SwitchType typeAux0;
  AuxInputPort tamper;
  device.SwitchType typeAux1;
  AuxInputPort fire;
  device.SwitchType typeAux2;
}
acFail
This is a predefined aux input port, and means AC Fail. By setting AUX_INPUT_PORT_NORMAL, it can be used as a normal port.
typeAux0
Specifies the switch type of the aux input port 0, which is predefined as acFail.
tamper
This is a preset aux input port, and means Tamper. By setting AUX_INPUT_PORT_NORMAL, it can be used as a normal port.
typeAux1
Specifies the switch type of the aux input port 0, which is predefined as tamper.
fire
This is a preset aux input port, and means Fire Alarm. By setting AUX_INPUT_PORT_NORMAL, it can be used as a normal port.
typeAux2
Specifies the switch type of the aux input port 0, which is predefined as fire.
message InputConfig {
  uint32 numOfInput;
  uint32 numOfSupervisedInput;
  AuxInput auxInput;
  repeated SupervisedInput supervisedInputs;
}
numOfInput
Number of input ports.
numOfSupervisedInput
Number of the supervised input ports.
auxInput
Sets the operation of Aux inputs.
supervisedInputs
Sets the operation of Supervised inputs

GetConfig

Get the input configuration of a device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
Response
Parameter Type Description
config InputConfig The input configuration of the device

SetConfig

Change the input configuration of a device.

Request
Parameter Type Description
deviceID uint32 The ID of the device
config InputConfig The input configuration to be written to the device

SetConfigMulti

Change the input configurations of multiple devices.

Request
Parameter Type Description
deviceIDs uint32[] The IDs of the devices
config InputConfig The input configuration to be written to the devices

Updated: