accessCodeControlPoint accessCodeSupportedConfiguration accessControlLevel accessoryFlags accessoryIdentifier active activeIdentifier activityInterval administratorOnlyAccess airParticulateDensity airParticulateSize airPlayEnable airQuality appMatchingIdentifier assetUpdateReadiness audioFeedback batteryLevel brightness buttonEvent ccaEnergyDetectThreshold ccaSignalDetectThreshold cameraOperatingModeIndicator carbonDioxideDetected carbonDioxideLevel carbonDioxidePeakLevel carbonMonoxideDetected carbonMonoxideLevel carbonMonoxidePeakLevel characteristicValueActiveTransitionCount characteristicValueTransitionControl chargingState closedCaptions colorTemperature configurationState configuredName contactSensorState coolingThresholdTemperature cryptoHash currentAirPurifierState currentAmbientLightLevel currentDoorState currentFanState currentHeaterCoolerState currentHeatingCoolingState currentHorizontalTiltAngle currentHumidifierDehumidifierState currentMediaState currentPosition currentRelativeHumidity currentSlatState currentTemperature currentTiltAngle currentTransport currentVerticalTiltAngle currentVisibilityState dataStreamHAPTransport dataStreamHAPTransportInterrupt diagonalFieldOfView digitalZoom displayOrder eventRetransmissionMaximum eventSnapshotsActive eventTransmissionCounters filterChangeIndication filterLifeLevel firmwareRevision firmwareUpdateReadiness firmwareUpdateStatus hardwareFinish hardwareRevision heartBeat heatingThresholdTemperature holdPosition homeKitCameraActive hue identifier identify imageMirroring imageRotation inUse inputDeviceType inputSourceType isConfigured leakDetected listPairings lockControlPoint lockCurrentState lockLastKnownAction lockManagementAutoSecurityTimeout lockPhysicalControls lockTargetState logs macRetransmissionMaximum macTransmissionCounters managedNetworkEnable manuallyDisabled manufacturer MaximumTransmitPower MetricsBufferFullState model motionDetected multiFunctionButton mute NFCAccessControlPoint NFCAccessSupportedConfiguration name networkAccessViolationControl networkClientProfileControl networkClientStatusControl nightVision nitrogenDioxideDensity obstructionDetected occupancyDetected on operatingStateResponse opticalZoom outletInUse ozoneDensity pm10Density pm2_5Density pairSetup pairVerify pairingFeatures pairingPairings passwordSetting periodicSnapshotsActive pictureMode ping positionState powerModeSelection productData programMode programmableSwitchEvent programmableSwitchOutputState receivedSignalStrengthIndication receiverSensitivity recordingAudioActive relativeHumidityDehumidifierThreshold relativeHumidityHumidifierThreshold relayControlPoint relayEnabled relayState remainingDuration remoteKey resetFilterIndication rotationDirection rotationSpeed routerStatus saturation securitySystemAlarmType securitySystemCurrentState securitySystemTargetState selectedAudioStreamConfiguration selectedCameraRecordingConfiguration selectedDiagnosticsModes selectedRTPStreamConfiguration selectedSleepConfiguration serialNumber serviceLabelIndex serviceLabelNamespace setDuration setupDataStreamTransport setupEndpoints setupTransferTransport signalToNoiseRatio siriEnable SiriEndpointSessionStatus siriEngineVersion siriInputType siriLightOnUse siriListening siriTouchToUse slatType sleepDiscoveryMode sleepInterval smokeDetected softwareRevision StagedFirmwareVersion statusActive statusFault statusJammed statusLowBattery statusTampered streamingStatus sulphurDioxideDensity supportedAssetTypes supportedAudioRecordingConfiguration supportedAudioStreamConfiguration supportedCameraRecordingConfiguration supportedCharacteristicValueTransitionConfiguration supportedDataStreamTransportConfiguration supportedDiagnosticsSnapshot supportedFirmwareUpdateConfiguration supportedMetrics supportedRTPConfiguration supportedRouterConfiguration supportedTransferTransportConfiguration supportedVideoRecordingConfiguration supportedVideoStreamConfiguration swingMode tapType targetAirPurifierState targetControlList targetControlSupportedConfiguration targetDoorState targetFanState targetHeaterCoolerState targetHeatingCoolingState targetHorizontalTiltAngle targetHumidifierDehumidifierState targetMediaState targetPosition targetRelativeHumidity targetTemperature targetTiltAngle targetVerticalTiltAngle targetVisibilityState temperatureDisplayUnits thirdPartyCameraActive threadControlPoint threadNodeCapabilities threadOpenThreadVersion threadStatus token transmitPower tunnelConnectionTimeout tunneledAccessoryAdvertising tunneledAccessoryConnected tunneledAccessoryStateNumber vocDensity valveType version videoAnalysisActive volume volumeControlType volumeSelector wanConfigurationList wanStatusList wakeConfiguration waterLevel wifiCapabilities wifiConfigurationControl wifiSatelliteStatus
Developers Guide Advanced TroubleShooting

CMD4 Portal

This auto generated document replaces much of the hard coded definitions and is the portal to everything that is Cmd4.

Enjoy

   John Talbot

AccessControl

UUID:000000DA-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: AccessControl,
            name: "MY_AccessControl",
            displayName: "MY_AccessControl",
            accessControlLevel: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AccessoryRuntimeInformation

UUID:00000239-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: AccessoryRuntimeInformation,
            name: "MY_AccessoryRuntimeInformation",
            displayName: "MY_AccessoryRuntimeInformation",
            ping: "0",
            activityInterval: < UINT32 >,
            heartBeat: < UINT32 >,
            sleepInterval: < UINT32 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AccessoryInformation

UUID:0000003E-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 TRUE
Cmd4 n/a
Model n/a
My_AccessoryInformation n/a
ABC001 n/a
100.1.1 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: AccessoryInformation,
            name: "MY_AccessoryInformation",
            displayName: "MY_AccessoryInformation",
            identify: "1",
            manufacturer: "Cmd4",
            model: "Model",
            name: "My_AccessoryInformation",
            serialNumber: "ABC001",
            firmwareRevision: "100.1.1",
            hardwareRevision: "< STRING> ",
            accessoryFlags: < UINT32 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AirPurifier

UUID:000000BB-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
2 PURIFYING_AIR
1 AUTO

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: AirPurifier,
            name: "MY_AirPurifier",
            displayName: "MY_AirPurifier",
            active: "1",
            currentAirPurifierState: "2",
            targetAirPurifierState: "1",
            lockPhysicalControls: < UINT8 >,
            name: "< STRING> ",
            swingMode: < UINT8 >,
            Unknown format float,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AirQualitySensor

UUID:0000008D-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
2 GOOD

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: AirQualitySensor,
            name: "MY_AirQualitySensor",
            displayName: "MY_AirQualitySensor",
            airQuality: "2",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            name: "< STRING> ",
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

BatteryService

UUID:00000096-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
50 n/a
0 NOT_CHARGING
0 BATTERY_LEVEL_NORMAL

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: BatteryService,
            name: "MY_BatteryService",
            displayName: "MY_BatteryService",
            batteryLevel: "50",
            chargingState: "0",
            statusLowBattery: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CameraEventRecordingManagement

UUID:00000204-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
0 n/a
0 n/a
0 n/a
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: CameraEventRecordingManagement,
            name: "MY_CameraEventRecordingManagement",
            displayName: "MY_CameraEventRecordingManagement",
            active: "1",
            supportedCameraRecordingConfiguration: "0",
            supportedVideoRecordingConfiguration: "0",
            supportedAudioRecordingConfiguration: "0",
            selectedCameraRecordingConfiguration: "0",
            recordingAudioActive: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CameraRTPStreamManagement

UUID:00000110-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a
0 n/a
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: CameraRTPStreamManagement,
            name: "MY_CameraRTPStreamManagement",
            displayName: "MY_CameraRTPStreamManagement",
            supportedVideoStreamConfiguration: "0",
            supportedAudioStreamConfiguration: "0",
            supportedRTPConfiguration: "0",
            selectedRTPStreamConfiguration: "0",
            streamingStatus: "0",
            setupEndpoints: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CameraOperatingMode

UUID:0000021A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 DISABLE
0 OFF

Optional Characteristics

Example config.json entry

         {
            type: CameraOperatingMode,
            name: "MY_CameraOperatingMode",
            displayName: "MY_CameraOperatingMode",
            eventSnapshotsActive: "0",
            homeKitCameraActive: "0",
            cameraOperatingModeIndicator: < BOOLEAN >,
            manuallyDisabled: < BOOLEAN >,
            nightVision: < BOOLEAN >,
            periodicSnapshotsActive: < UINT8 >,
            thirdPartyCameraActive: < UINT8 >,
            Unknown format float,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CarbonDioxideSensor

UUID:00000097-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 CO2_LEVELS_NORMAL

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: CarbonDioxideSensor,
            name: "MY_CarbonDioxideSensor",
            displayName: "MY_CarbonDioxideSensor",
            carbonDioxideDetected: "0",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusLowBattery: < UINT8 >,
            statusTampered: < UINT8 >,
            Unknown format float,
            Unknown format float,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CarbonMonoxideSensor

UUID:0000007F-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 CO_LEVELS_NORMAL

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: CarbonMonoxideSensor,
            name: "MY_CarbonMonoxideSensor",
            displayName: "MY_CarbonMonoxideSensor",
            carbonMonoxideDetected: "0",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusLowBattery: < UINT8 >,
            statusTampered: < UINT8 >,
            Unknown format float,
            Unknown format float,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

ContactSensor

UUID:00000080-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 CONTACT_NOT_DETECTED

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: ContactSensor,
            name: "MY_ContactSensor",
            displayName: "MY_ContactSensor",
            contactSensorState: "1",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Diagnostics

UUID:00000237-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: Diagnostics,
            name: "MY_Diagnostics",
            displayName: "MY_Diagnostics",
            supportedDiagnosticsSnapshot: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Door

UUID:00000081-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
2 STOPPED
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Door,
            name: "MY_Door",
            displayName: "MY_Door",
            currentPosition: "0",
            positionState: "2",
            targetPosition: "0",
            holdPosition: < BOOLEAN >,
            obstructionDetected: < BOOLEAN >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

DoorBell

UUID:00000121-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 SINGLE_PRESS

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: DoorBell,
            name: "MY_DoorBell",
            displayName: "MY_DoorBell",
            programmableSwitchEvent: "0",
            brightness: < INT >,
            mute: < BOOLEAN >,
            name: "< STRING> ",
            volume: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Fan

UUID:00000040-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Fan,
            name: "MY_Fan",
            displayName: "MY_Fan",
            on: "0",
            rotationDirection: < INT >,
            Unknown format float,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Fanv1

UUID:00000040-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Fanv1,
            name: "MY_Fanv1",
            displayName: "MY_Fanv1",
            on: "0",
            rotationDirection: < INT >,
            Unknown format float,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Fanv2

UUID:000000B7-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Fanv2,
            name: "MY_Fanv2",
            displayName: "MY_Fanv2",
            active: "1",
            currentFanState: < UINT8 >,
            targetFanState: < UINT8 >,
            lockPhysicalControls: < UINT8 >,
            name: "< STRING> ",
            rotationDirection: < INT >,
            Unknown format float,
            swingMode: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Faucet

UUID:000000D7-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Faucet,
            name: "MY_Faucet",
            displayName: "MY_Faucet",
            active: "1",
            name: "< STRING> ",
            statusFault: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

FilterMaintenance

UUID:000000BA-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FILTER_OK

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: FilterMaintenance,
            name: "MY_FilterMaintenance",
            displayName: "MY_FilterMaintenance",
            filterChangeIndication: "0",
            Unknown format float,
            resetFilterIndication: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

GarageDoorOpener

UUID:00000041-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 OPEN
0 OPEN
1 TRUE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: GarageDoorOpener,
            name: "MY_GarageDoorOpener",
            displayName: "MY_GarageDoorOpener",
            currentDoorState: "0",
            targetDoorState: "0",
            obstructionDetected: "1",
            lockCurrentState: < UINT8 >,
            lockTargetState: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

HeaterCooler

UUID:000000BC-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
0 INACTIVE
1 HEAT
22.2 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: HeaterCooler,
            name: "MY_HeaterCooler",
            displayName: "MY_HeaterCooler",
            active: "1",
            currentHeaterCoolerState: "0",
            targetHeaterCoolerState: "1",
            currentTemperature: "22.2",
            lockPhysicalControls: < UINT8 >,
            name: "< STRING> ",
            Unknown format float,
            swingMode: < UINT8 >,
            Unknown format float,
            Unknown format float,
            temperatureDisplayUnits: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

HumidifierDehumidifier

UUID:000000BD-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
60 n/a
1 IDLE
2 DEHUMIDIFIER
1 ACTIVE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: HumidifierDehumidifier,
            name: "MY_HumidifierDehumidifier",
            displayName: "MY_HumidifierDehumidifier",
            currentRelativeHumidity: "60",
            currentHumidifierDehumidifierState: "1",
            targetHumidifierDehumidifierState: "2",
            active: "1",
            lockPhysicalControls: < UINT8 >,
            name: "< STRING> ",
            Unknown format float,
            Unknown format float,
            Unknown format float,
            swingMode: < UINT8 >,
            Unknown format float,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

HumiditySensor

UUID:00000082-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
60 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: HumiditySensor,
            name: "MY_HumiditySensor",
            displayName: "MY_HumiditySensor",
            currentRelativeHumidity: "60",
            name: "< STRING> ",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

InputSource

UUID:000000D9-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
My_InputSource n/a
1 HOME_SCREEN
1 CONFIGURED
0 SHOWN

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: InputSource,
            name: "MY_InputSource",
            displayName: "MY_InputSource",
            configuredName: "My_InputSource",
            inputSourceType: "1",
            isConfigured: "1",
            currentVisibilityState: "0",
            identifier: < UINT32 >,
            inputDeviceType: < UINT8 >,
            targetVisibilityState: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

IrrigationSystem

UUID:000000CF-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
0 NO_PROGRAM_SCHEDULED
1 IN_USE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: IrrigationSystem,
            name: "MY_IrrigationSystem",
            displayName: "MY_IrrigationSystem",
            active: "1",
            programMode: "0",
            inUse: "1",
            name: "< STRING> ",
            remainingDuration: < UINT32 >,
            statusFault: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

LeakSensor

UUID:00000083-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 LEAK_NOT_DETECTED

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: LeakSensor,
            name: "MY_LeakSensor",
            displayName: "MY_LeakSensor",
            leakDetected: "0",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

LightSensor

UUID:00000084-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: LightSensor,
            name: "MY_LightSensor",
            displayName: "MY_LightSensor",
            currentAmbientLightLevel: "1",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Lightbulb

UUID:00000043-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Lightbulb,
            name: "MY_Lightbulb",
            displayName: "MY_Lightbulb",
            on: "0",
            brightness: < INT >,
            Unknown format float,
            Unknown format float,
            name: "< STRING> ",
            colorTemperature: < INT >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

LockManagement

UUID:00000044-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0.0.0 n/a

Optional Characteristics

Example config.json entry

         {
            type: LockManagement,
            name: "MY_LockManagement",
            displayName: "MY_LockManagement",
            lockControlPoint: "0",
            version: "0.0.0",
            administratorOnlyAccess: < BOOLEAN >,
            audioFeedback: < BOOLEAN >,
            currentDoorState: < UINT8 >,
            lockManagementAutoSecurityTimeout: < UINT32 >,
            lockLastKnownAction: < UINT8 >,
            motionDetected: < BOOLEAN >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

LockMechanism

UUID:00000045-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 UNSECURED
0 UNSECURED

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: LockMechanism,
            name: "MY_LockMechanism",
            displayName: "MY_LockMechanism",
            lockCurrentState: "0",
            lockTargetState: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Microphone

UUID:00000112-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Microphone,
            name: "MY_Microphone",
            displayName: "MY_Microphone",
            mute: "0",
            volume: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

MotionSensor

UUID:00000085-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 TRUE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: MotionSensor,
            name: "MY_MotionSensor",
            displayName: "MY_MotionSensor",
            motionDetected: "1",
            name: "< STRING> ",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusLowBattery: < UINT8 >,
            statusTampered: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

OccupancySensor

UUID:00000086-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 OCCUPANCY_NOT_DETECTED

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: OccupancySensor,
            name: "MY_OccupancySensor",
            displayName: "MY_OccupancySensor",
            occupancyDetected: "0",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            statusLowBattery: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Outlet

UUID:00000047-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Outlet,
            name: "MY_Outlet",
            displayName: "MY_Outlet",
            on: "0",
            outletInUse: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Pairing

UUID:00000055-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 n/a
0 n/a
0 n/a
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Pairing,
            name: "MY_Pairing",
            displayName: "MY_Pairing",
            listPairings: "1",
            pairSetup: "0",
            pairVerify: "0",
            pairingFeatures: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

PowerManagement

UUID:00000221-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: PowerManagement,
            name: "MY_PowerManagement",
            displayName: "MY_PowerManagement",
            wakeConfiguration: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

ProtocolInformation

UUID:000000A2-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1.2.3 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: ProtocolInformation,
            name: "MY_ProtocolInformation",
            displayName: "MY_ProtocolInformation",
            version: "1.2.3",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Relay

UUID:0000005A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 TRUE
1 n/a
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Relay,
            name: "MY_Relay",
            displayName: "MY_Relay",
            relayEnabled: "1",
            relayState: "1",
            relayControlPoint: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

SecuritySystem

UUID:0000007E-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
3 DISARMED
3 DISARM

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: SecuritySystem,
            name: "MY_SecuritySystem",
            displayName: "MY_SecuritySystem",
            securitySystemCurrentState: "3",
            securitySystemTargetState: "3",
            name: "< STRING> ",
            securitySystemAlarmType: < UINT8 >,
            statusFault: < UINT8 >,
            statusTampered: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

ServiceLabel

UUID:000000CC-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 DOTS

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: ServiceLabel,
            name: "MY_ServiceLabel",
            displayName: "MY_ServiceLabel",
            serviceLabelNamespace: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Siri

UUID:00000133-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 PUSH_BUTTON_TRIGGERED_APPLE_TV

Optional Characteristics

Example config.json entry

         {
            type: Siri,
            name: "MY_Siri",
            displayName: "MY_Siri",
            siriInputType: "0",
            multiFunctionButton: < UINT8 >,
            siriEnable: < UINT8 >,
            siriEngineVersion: "< STRING> ",
            siriLightOnUse: < UINT8 >,
            siriListening: < UINT8 >,
            siriTouchToUse: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Slats

UUID:000000B9-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FIXED
0 HORIZONTAL

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Slats,
            name: "MY_Slats",
            displayName: "MY_Slats",
            currentSlatState: "0",
            slatType: "0",
            name: "< STRING> ",
            swingMode: < UINT8 >,
            currentTiltAngle: < INT >,
            targetTiltAngle: < INT >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

SmartSpeaker

UUID:00000228-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
2 STOP
2 STOP

Optional Characteristics

Example config.json entry

         {
            type: SmartSpeaker,
            name: "MY_SmartSpeaker",
            displayName: "MY_SmartSpeaker",
            currentMediaState: "2",
            targetMediaState: "2",
            airPlayEnable: < UINT8 >,
            configuredName: "< STRING> ",
            mute: < BOOLEAN >,
            name: "< STRING> ",
            volume: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

SmokeSensor

UUID:00000087-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 SMOKE_NOT_DETECTED

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: SmokeSensor,
            name: "MY_SmokeSensor",
            displayName: "MY_SmokeSensor",
            smokeDetected: "0",
            name: "< STRING> ",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusLowBattery: < UINT8 >,
            statusTampered: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Speaker

UUID:00000113-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Speaker,
            name: "MY_Speaker",
            displayName: "MY_Speaker",
            mute: "0",
            active: < UINT8 >,
            volume: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

StatefulProgrammableSwitch

UUID:00000088-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 SINGLE_PRESS
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: StatefulProgrammableSwitch,
            name: "MY_StatefulProgrammableSwitch",
            displayName: "MY_StatefulProgrammableSwitch",
            programmableSwitchEvent: "0",
            programmableSwitchOutputState: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

StatelessProgrammableSwitch

UUID:00000089-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 SINGLE_PRESS

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: StatelessProgrammableSwitch,
            name: "MY_StatelessProgrammableSwitch",
            displayName: "MY_StatelessProgrammableSwitch",
            programmableSwitchEvent: "0",
            name: "< STRING> ",
            serviceLabelIndex: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Switch

UUID:00000049-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Switch,
            name: "MY_Switch",
            displayName: "MY_Switch",
            on: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TargetControl

UUID:00000125-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
7 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: TargetControl,
            name: "MY_TargetControl",
            displayName: "MY_TargetControl",
            active: "1",
            activeIdentifier: "7",
            buttonEvent: "0",
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TargetControlManagement

UUID:00000122-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: TargetControlManagement,
            name: "MY_TargetControlManagement",
            displayName: "MY_TargetControlManagement",
            targetControlSupportedConfiguration: "0",
            targetControlList: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Television

UUID:000000D8-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
123 n/a
My_Tv n/a
8 SELECT
1 ALWAYS_DISCOVERABLE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Television,
            name: "MY_Television",
            displayName: "MY_Television",
            active: "1",
            activeIdentifier: "123",
            configuredName: "My_Tv",
            remoteKey: "8",
            sleepDiscoveryMode: "1",
            brightness: < INT >,
            closedCaptions: < UINT8 >,
            currentMediaState: < UINT8 >,
            targetMediaState: < UINT8 >,
            name: "< STRING> ",
            pictureMode: < UINT8 >,
            powerModeSelection: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TelevisionSpeaker

UUID:00000113-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: TelevisionSpeaker,
            name: "MY_TelevisionSpeaker",
            displayName: "MY_TelevisionSpeaker",
            mute: "0",
            active: < UINT8 >,
            volume: < UINT8 >,
            volumeControlType: < UINT8 >,
            volumeSelector: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TemperatureSensor

UUID:0000008A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
50 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: TemperatureSensor,
            name: "MY_TemperatureSensor",
            displayName: "MY_TemperatureSensor",
            currentTemperature: "50",
            name: "< STRING> ",
            statusActive: < BOOLEAN >,
            statusFault: < UINT8 >,
            statusLowBattery: < UINT8 >,
            statusTampered: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Thermostat

UUID:0000004A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 OFF
0 OFF
50 n/a
50 n/a
0 CELSIUS

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Thermostat,
            name: "MY_Thermostat",
            displayName: "MY_Thermostat",
            currentHeatingCoolingState: "0",
            targetHeatingCoolingState: "0",
            currentTemperature: "50",
            targetTemperature: "50",
            temperatureDisplayUnits: "0",
            name: "< STRING> ",
            Unknown format float,
            Unknown format float,
            Unknown format float,
            Unknown format float,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TransferTransportManagement

UUID:00000203-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: TransferTransportManagement,
            name: "MY_TransferTransportManagement",
            displayName: "MY_TransferTransportManagement",
            supportedTransferTransportConfiguration: "0",
            setupTransferTransport: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TunneledBTLEAccessoryService

UUID:00000056-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
My_TunnelB n/a
TLB n/a
0 n/a
0 FALSE
0 FALSE
5000 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: TunneledBTLEAccessoryService,
            name: "MY_TunneledBTLEAccessoryService",
            displayName: "MY_TunneledBTLEAccessoryService",
            name: "My_TunnelB",
            accessoryIdentifier: "TLB",
            tunneledAccessoryStateNumber: "0",
            tunneledAccessoryConnected: "0",
            tunneledAccessoryAdvertising: "0",
            tunnelConnectionTimeout: "5000",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Valve

UUID:000000D0-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
1 IN_USE
0 GENERIC_VALVE

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Valve,
            name: "MY_Valve",
            displayName: "MY_Valve",
            active: "1",
            inUse: "1",
            valveType: "0",
            isConfigured: < UINT8 >,
            name: "< STRING> ",
            remainingDuration: < UINT32 >,
            serviceLabelIndex: < UINT8 >,
            setDuration: < UINT32 >,
            statusFault: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

WiFiRouter

UUID:0000020A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
My_WiFiRouter n/a
0 DISABLED
0 n/a
0 n/a
0 n/a
0 READY
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: WiFiRouter,
            name: "MY_WiFiRouter",
            displayName: "MY_WiFiRouter",
            configuredName: "My_WiFiRouter",
            managedNetworkEnable: "0",
            networkAccessViolationControl: "0",
            networkClientProfileControl: "0",
            networkClientStatusControl: "0",
            routerStatus: "0",
            supportedRouterConfiguration: "0",
            wanConfigurationList: "0",
            wanStatusList: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

WiFiSatellite

UUID:0000020F-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
2 NOT_CONNECTED

Optional Characteristics

Example config.json entry

         {
            type: WiFiSatellite,
            name: "MY_WiFiSatellite",
            displayName: "MY_WiFiSatellite",
            wifiSatelliteStatus: "2",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Window

UUID:0000008B-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
2 STOPPED
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: Window,
            name: "MY_Window",
            displayName: "MY_Window",
            currentPosition: "0",
            positionState: "2",
            targetPosition: "0",
            name: "< STRING> ",
            obstructionDetected: < BOOLEAN >,
            holdPosition: < BOOLEAN >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

WindowCovering

UUID:0000008C-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
2 STOPPED
0 n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: WindowCovering,
            name: "MY_WindowCovering",
            displayName: "MY_WindowCovering",
            currentPosition: "0",
            positionState: "2",
            targetPosition: "0",
            currentHorizontalTiltAngle: < INT >,
            targetHorizontalTiltAngle: < INT >,
            name: "< STRING> ",
            obstructionDetected: < BOOLEAN >,
            holdPosition: < BOOLEAN >,
            currentVerticalTiltAngle: < INT >,
            targetVerticalTiltAngle: < INT >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AccessoryMetrics

UUID:00000270-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
1 n/a
n/a

Optional Characteristics

Default Polling Characteristics

Default polling characteristics are characteristics that would automatically be polled if Accessory Polling is configured ( polling:true ) instead of characteristic polling where each characteristic is set individually.

Example config.json entry

         {
            type: AccessoryMetrics,
            name: "MY_AccessoryMetrics",
            displayName: "MY_AccessoryMetrics",
            active: "1",
            MetricsBufferFullState: "1",
            supportedMetrics: "",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AssetUpdate

UUID:00000267-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: AssetUpdate,
            name: "MY_AssetUpdate",
            displayName: "MY_AssetUpdate",
            assetUpdateReadiness: "0",
            supportedAssetTypes: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Assistant

UUID:0000026A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
Some Identifier n/a
Unnamed Assistant n/a

Optional Characteristics

Example config.json entry

         {
            type: Assistant,
            name: "MY_Assistant",
            displayName: "MY_Assistant",
            active: "1",
            identifier: "Some Identifier",
            name: "Unnamed Assistant",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AudioStreamManagement

UUID:00000127-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: AudioStreamManagement,
            name: "MY_AudioStreamManagement",
            displayName: "MY_AudioStreamManagement",
            supportedAudioStreamConfiguration: "0",
            selectedAudioStreamConfiguration: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

Battery

UUID:00000096-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 BATTERY_LEVEL_NORMAL

Optional Characteristics

Example config.json entry

         {
            type: Battery,
            name: "MY_Battery",
            displayName: "MY_Battery",
            statusLowBattery: "0",
            batteryLevel: < UINT8 >,
            chargingState: < UINT8 >,
            name: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CameraRecordingManagement

UUID:00000204-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
0 n/a
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: CameraRecordingManagement,
            name: "MY_CameraRecordingManagement",
            displayName: "MY_CameraRecordingManagement",
            active: "1",
            supportedCameraRecordingConfiguration: "0",
            supportedVideoRecordingConfiguration: "0",
            supportedAudioRecordingConfiguration: "0",
            selectedCameraRecordingConfiguration: "0",
            recordingAudioActive: < UINT8 >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

CloudRelay

UUID:0000005A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
1 n/a
false FALSE

Optional Characteristics

Example config.json entry

         {
            type: CloudRelay,
            name: "MY_CloudRelay",
            displayName: "MY_CloudRelay",
            relayControlPoint: "0",
            relayState: "1",
            relayEnabled: "false",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

DataStreamTransportManagement

UUID:00000129-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a
Unknown version n/a

Optional Characteristics

Example config.json entry

         {
            type: DataStreamTransportManagement,
            name: "MY_DataStreamTransportManagement",
            displayName: "MY_DataStreamTransportManagement",
            setupDataStreamTransport: "0",
            supportedCharacteristicValueTransitionConfiguration: "0",
            version: "Unknown version",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

NFCAccess

UUID:00000266-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: NFCAccess,
            name: "MY_NFCAccess",
            displayName: "MY_NFCAccess",
            configurationState: "0",
            NFCAccessControlPoint: "0",
            NFCAccessSupportedConfiguration: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

SiriEndpoint

UUID:00000253-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
Unknown version n/a

Optional Characteristics

Example config.json entry

         {
            type: SiriEndpoint,
            name: "MY_SiriEndpoint",
            displayName: "MY_SiriEndpoint",
            SiriEndpointSessionStatus: "0",
            version: "Unknown version",
            activeIdentifier: < UINT32 >,
            manuallyDisabled: < BOOLEAN >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

ThreadTransport

UUID:00000701-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: ThreadTransport,
            name: "MY_ThreadTransport",
            displayName: "MY_ThreadTransport",
            currentTransport: "0",
            threadControlPoint: "0",
            threadNodeCapabilities: "0",
            threadStatus: "0",
            ccaEnergyDetectThreshold: < INT >,
            ccaSignalDetectThreshold: < INT >,
            eventRetransmissionMaximum: < UINT8 >,
            eventTransmissionCounters: < UINT32 >,
            macRetransmissionMaximum: < UINT8 >,
            macTransmissionCounters: < DATA >,
            receiverSensitivity: < INT >,
            receivedSignalStrengthIndication: < INT >,
            signalToNoiseRatio: < INT >,
            threadOpenThreadVersion: "< STRING> ",
            transmitPower: < INT >,
            MaximumTransmitPower: < INT >,
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

AccessCode

UUID:00000260-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: AccessCode,
            name: "MY_AccessCode",
            displayName: "MY_AccessCode",
            accessCodeControlPoint: "0",
            accessCodeSupportedConfiguration: "0",
            configurationState: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

FirmwareUpdate

UUID:00000236-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 n/a
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: FirmwareUpdate,
            name: "MY_FirmwareUpdate",
            displayName: "MY_FirmwareUpdate",
            firmwareUpdateReadiness: "0",
            firmwareUpdateStatus: "0",
            StagedFirmwareVersion: "< STRING> ",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

TapManagement

UUID:0000022E-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
1 ACTIVE
0 n/a
0 n/a
n/a

Optional Characteristics

Example config.json entry

         {
            type: TapManagement,
            name: "MY_TapManagement",
            displayName: "MY_TapManagement",
            active: "1",
            cryptoHash: "0",
            tapType: "0",
            token: "",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

WiFiTransport

UUID:0000022A-0000-1000-8000-0026BB765291

Required Characteristics

Default Value Constant
0 FALSE
0 n/a

Optional Characteristics

Example config.json entry

         {
            type: WiFiTransport,
            name: "MY_WiFiTransport",
            displayName: "MY_WiFiTransport",
            currentTransport: "0",
            wifiCapabilities: "0",
            state_cmd: < "STRING" >,
            polling: < POLLING>

         }
         
See additional CMD4 Accessory Directives

accessControlLevel

Properties

Type: accessControlLevel
UUID: 000000E5-0000-1000-8000-0026BB765291
Format: uint16
Max Value: 2
Min Step: 1
Perms: Events, Paired Read, Paired Write

accessoryFlags

Properties

Type: accessoryFlags
UUID: 000000A6-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read, Events

accessoryIdentifier

Properties

Type: accessoryIdentifier
UUID: 00000057-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

active

Properties

Type: active
UUID: 000000B0-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "INACTIVE"
1 "ACTIVE"

activeIdentifier

Properties

Type: activeIdentifier
UUID: 000000E7-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read, Paired Write, Events

activityInterval

Properties

Type: activityInterval
UUID: 0000023B-0000-1000-8000-0026BB765291
Format: uint32
Min Step: 1
Perms: Paired Read, Events

administratorOnlyAccess

Properties

Type: administratorOnlyAccess
UUID: 00000001-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

airParticulateDensity

Properties

Type: airParticulateDensity
UUID: 00000064-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Perms: Paired Read, Events

airParticulateSize

Properties

Type: airParticulateSize
UUID: 00000065-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "_2_5_M"
1 "_10_M"

airQuality

Properties

Type: airQuality
UUID: 00000095-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 5
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "UNKNOWN"
1 "EXCELLENT"
2 "GOOD"
3 "FAIR"
4 "INFERIOR"
5 "POOR"

appMatchingIdentifier

Properties

Type: appMatchingIdentifier
UUID: 000000A4-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

audioFeedback

Properties

Type: audioFeedback
UUID: 00000005-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

batteryLevel

Properties

Type: batteryLevel
UUID: 00000068-0000-1000-8000-0026BB765291
Format: uint8
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

brightness

Properties

Type: brightness
UUID: 00000008-0000-1000-8000-0026BB765291
Format: int
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

buttonEvent

Properties

Type: buttonEvent
UUID: 00000126-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

ccaEnergyDetectThreshold

Properties

Type: ccaEnergyDetectThreshold
UUID: 00000246-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

ccaSignalDetectThreshold

Properties

Type: ccaSignalDetectThreshold
UUID: 00000245-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

cameraOperatingModeIndicator

Properties

Type: cameraOperatingModeIndicator
UUID: 0000021D-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events, Timed Write

Constants

Value String
0 "DISABLE"
1 "ENABLE"

carbonDioxideDetected

Properties

Type: carbonDioxideDetected
UUID: 00000092-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "CO2_LEVELS_NORMAL"
1 "CO2_LEVELS_ABNORMAL"

carbonDioxideLevel

Properties

Type: carbonDioxideLevel
UUID: 00000093-0000-1000-8000-0026BB765291
Format: float
Max Value: 100000
Min Step: 1
Perms: Paired Read, Events

carbonDioxidePeakLevel

Properties

Type: carbonDioxidePeakLevel
UUID: 00000094-0000-1000-8000-0026BB765291
Format: float
Max Value: 100000
Min Step: 1
Perms: Paired Read, Events

carbonMonoxideDetected

Properties

Type: carbonMonoxideDetected
UUID: 00000069-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "CO_LEVELS_NORMAL"
1 "CO_LEVELS_ABNORMAL"

carbonMonoxideLevel

Properties

Type: carbonMonoxideLevel
UUID: 00000090-0000-1000-8000-0026BB765291
Format: float
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

carbonMonoxidePeakLevel

Properties

Type: carbonMonoxidePeakLevel
UUID: 00000091-0000-1000-8000-0026BB765291
Format: float
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

characteristicValueTransitionControl

Properties

Type: characteristicValueTransitionControl
UUID: 00000143-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

chargingState

Properties

Type: chargingState
UUID: 0000008F-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NOT_CHARGING"
1 "CHARGING"
2 "NOT_CHARGEABLE"

closedCaptions

Properties

Type: closedCaptions
UUID: 000000DD-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "DISABLED"
1 "ENABLED"

colorTemperature

Properties

Type: colorTemperature
UUID: 000000CE-0000-1000-8000-0026BB765291
Format: int
Min Value: 140
Max Value: 500
Min Step: 1
Perms: Paired Read, Paired Write, Events

configuredName

Properties

Type: configuredName
UUID: 000000E3-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read, Paired Write, Events

contactSensorState

Properties

Type: contactSensorState
UUID: 0000006A-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "CONTACT_DETECTED"
1 "CONTACT_NOT_DETECTED"

coolingThresholdTemperature

Properties

Type: coolingThresholdTemperature
UUID: 0000000D-0000-1000-8000-0026BB765291
Format: float
Unit: celsius
Min Value: 10
Max Value: 35
Min Step: 0.1
Perms: Paired Read, Paired Write, Events

currentAirPurifierState

Properties

Type: currentAirPurifierState
UUID: 000000A9-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "INACTIVE"
1 "IDLE"
2 "PURIFYING_AIR"

currentAmbientLightLevel

Properties

Type: currentAmbientLightLevel
UUID: 0000006B-0000-1000-8000-0026BB765291
Format: float
Unit: lux
Min Value: 0.0001
Max Value: 100000
Perms: Paired Read, Events

currentDoorState

Properties

Type: currentDoorState
UUID: 0000000E-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 4
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "OPEN"
1 "CLOSED"
2 "OPENING"
3 "CLOSING"
4 "STOPPED"

currentFanState

Properties

Type: currentFanState
UUID: 000000AF-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "INACTIVE"
1 "IDLE"
2 "BLOWING_AIR"

currentHeaterCoolerState

Properties

Type: currentHeaterCoolerState
UUID: 000000B1-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "INACTIVE"
1 "IDLE"
2 "HEATING"
3 "COOLING"

currentHeatingCoolingState

Properties

Type: currentHeatingCoolingState
UUID: 0000000F-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "OFF"
1 "HEAT"
2 "COOL"
3 "AUTO"

currentHorizontalTiltAngle

Properties

Type: currentHorizontalTiltAngle
UUID: 0000006C-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Events

currentHumidifierDehumidifierState

Properties

Type: currentHumidifierDehumidifierState
UUID: 000000B3-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "INACTIVE"
1 "IDLE"
2 "HUMIDIFYING"
3 "DEHUMIDIFYING"

currentMediaState

Properties

Type: currentMediaState
UUID: 000000E0-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 5
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "PLAY"
1 "PAUSE"
2 "STOP"
4 "LOADING"
5 "INTERRUPTED"

currentPosition

Properties

Type: currentPosition
UUID: 0000006D-0000-1000-8000-0026BB765291
Format: uint8
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

currentRelativeHumidity

Properties

Type: currentRelativeHumidity
UUID: 00000010-0000-1000-8000-0026BB765291
Format: float
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

currentSlatState

Properties

Type: currentSlatState
UUID: 000000AA-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "FIXED"
1 "JAMMED"
2 "SWINGING"

currentTemperature

Properties

Type: currentTemperature
UUID: 00000011-0000-1000-8000-0026BB765291
Format: float
Unit: celsius
Min Value: -270
Max Value: 100
Min Step: 0.1
Perms: Paired Read, Events

currentTiltAngle

Properties

Type: currentTiltAngle
UUID: 000000C1-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Events

currentTransport

Properties

Type: currentTransport
UUID: 0000022B-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read

Constants

Value String
0 "FALSE"
1 "TRUE"

currentVerticalTiltAngle

Properties

Type: currentVerticalTiltAngle
UUID: 0000006E-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Events

currentVisibilityState

Properties

Type: currentVisibilityState
UUID: 00000135-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "SHOWN"
1 "HIDDEN"

dataStreamHAPTransport

Properties

Type: dataStreamHAPTransport
UUID: 00000138-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

dataStreamHAPTransportInterrupt

Properties

Type: dataStreamHAPTransportInterrupt
UUID: 00000139-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

diagonalFieldOfView

Properties

Type: diagonalFieldOfView
UUID: 00000224-0000-1000-8000-0026BB765291
Format: float
Unit: arcdegrees
Max Value: 360
Perms: Paired Read, Events

digitalZoom

Properties

Type: digitalZoom
UUID: 0000011D-0000-1000-8000-0026BB765291
Format: float
Min Step: 0.1
Perms: Paired Read, Paired Write, Events

displayOrder

Properties

Type: displayOrder
UUID: 00000136-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events

eventRetransmissionMaximum

Properties

Type: eventRetransmissionMaximum
UUID: 0000023D-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read

eventSnapshotsActive

Properties

Type: eventSnapshotsActive
UUID: 00000223-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "DISABLE"
1 "ENABLE"

eventTransmissionCounters

Properties

Type: eventTransmissionCounters
UUID: 0000023E-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read

filterChangeIndication

Properties

Type: filterChangeIndication
UUID: 000000AC-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "FILTER_OK"
1 "CHANGE_FILTER"

filterLifeLevel

Properties

Type: filterLifeLevel
UUID: 000000AB-0000-1000-8000-0026BB765291
Format: float
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

firmwareRevision

Properties

Type: firmwareRevision
UUID: 00000052-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

hardwareRevision

Properties

Type: hardwareRevision
UUID: 00000053-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

heartBeat

Properties

Type: heartBeat
UUID: 0000024A-0000-1000-8000-0026BB765291
Format: uint32
Perms: Events, Paired Read

heatingThresholdTemperature

Properties

Type: heatingThresholdTemperature
UUID: 00000012-0000-1000-8000-0026BB765291
Format: float
Unit: celsius
Max Value: 25
Min Step: 0.1
Perms: Paired Read, Paired Write, Events

holdPosition

Properties

Type: holdPosition
UUID: 0000006F-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Write

Constants

Value String
0 "FALSE"
1 "TRUE"

homeKitCameraActive

Properties

Type: homeKitCameraActive
UUID: 0000021B-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "OFF"
1 "ON"

hue

Properties

Type: hue
UUID: 00000013-0000-1000-8000-0026BB765291
Format: float
Unit: arcdegrees
Max Value: 360
Min Step: 1
Perms: Paired Read, Paired Write, Events

identifier

Properties

Type: identifier
UUID: 000000E6-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read

identify

Properties

Type: identify
UUID: 00000014-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Write

Constants

Value String
0 "FALSE"
1 "TRUE"

imageMirroring

Properties

Type: imageMirroring
UUID: 0000011F-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

imageRotation

Properties

Type: imageRotation
UUID: 0000011E-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Max Value: 360
Min Step: 1
Perms: Paired Read, Paired Write, Events

inUse

Properties

Type: inUse
UUID: 000000D2-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NOT_IN_USE"
1 "IN_USE"

inputDeviceType

Properties

Type: inputDeviceType
UUID: 000000DC-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 6
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "OTHER"
1 "TV"
2 "RECORDING"
3 "TUNER"
4 "PLAYBACK"
5 "AUDIO_SYSTEM"
undefined "UNKNOWN_6"

inputSourceType

Properties

Type: inputSourceType
UUID: 000000DB-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 10
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "OTHER"
1 "HOME_SCREEN"
2 "TUNER"
3 "HDMI"
4 "COMPOSITE_VIDEO"
5 "S_VIDEO"
6 "COMPONENT_VIDEO"
7 "DVI"
8 "AIRPLAY"
9 "USB"
10 "APPLICATION"

isConfigured

Properties

Type: isConfigured
UUID: 000000D6-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "NOT_CONFIGURED"
1 "CONFIGURED"

leakDetected

Properties

Type: leakDetected
UUID: 00000070-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "LEAK_NOT_DETECTED"
1 "LEAK_DETECTED"

listPairings

Properties

Type: listPairings
UUID: 00000050-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

lockControlPoint

Properties

Type: lockControlPoint
UUID: 00000019-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Write

lockCurrentState

Properties

Type: lockCurrentState
UUID: 0000001D-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "UNSECURED"
1 "SECURED"
2 "JAMMED"
3 "UNKNOWN"

lockLastKnownAction

Properties

Type: lockLastKnownAction
UUID: 0000001C-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 10
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "SECURED_PHYSICALLY_INTERIOR"
1 "UNSECURED_PHYSICALLY_INTERIOR"
2 "SECURED_PHYSICALLY_EXTERIOR"
3 "UNSECURED_PHYSICALLY_EXTERIOR"
4 "SECURED_BY_KEYPAD"
5 "UNSECURED_BY_KEYPAD"
6 "SECURED_REMOTELY"
7 "UNSECURED_REMOTELY"
8 "SECURED_BY_AUTO_SECURE_TIMEOUT"
9 "SECURED_PHYSICALLY"
10 "UNSECURED_PHYSICALLY"

lockManagementAutoSecurityTimeout

Properties

Type: lockManagementAutoSecurityTimeout
UUID: 0000001A-0000-1000-8000-0026BB765291
Format: uint32
Unit: seconds
Perms: Paired Read, Paired Write, Events

lockPhysicalControls

Properties

Type: lockPhysicalControls
UUID: 000000A7-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "CONTROL_LOCK_DISABLED"
1 "CONTROL_LOCK_ENABLED"

lockTargetState

Properties

Type: lockTargetState
UUID: 0000001E-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "UNSECURED"
1 "SECURED"

logs

Properties

Type: logs
UUID: 0000001F-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

macRetransmissionMaximum

Properties

Type: macRetransmissionMaximum
UUID: 00000247-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read

macTransmissionCounters

Properties

Type: macTransmissionCounters
UUID: 00000248-0000-1000-8000-0026BB765291
Format: data
Perms: Paired Read

managedNetworkEnable

Properties

Type: managedNetworkEnable
UUID: 00000215-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Paired Read, Paired Write, Events, Timed Write

Constants

Value String
0 "DISABLED"
1 "ENABLED"
2 "UNKNOWN"

manuallyDisabled

Properties

Type: manuallyDisabled
UUID: 00000227-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Events

Constants

Value String
0 "ENABLED"
1 "DISABLED"

manufacturer

Properties

Type: manufacturer
UUID: 00000020-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

model

Properties

Type: model
UUID: 00000021-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

motionDetected

Properties

Type: motionDetected
UUID: 00000022-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

mute

Properties

Type: mute
UUID: 0000011A-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

name

Properties

Type: name
UUID: 00000023-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

networkAccessViolationControl

Properties

Type: networkAccessViolationControl
UUID: 0000021F-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events, Timed Write, Write Response

networkClientProfileControl

Properties

Type: networkClientProfileControl
UUID: 0000020C-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events, Timed Write, Write Response

networkClientStatusControl

Properties

Type: networkClientStatusControl
UUID: 0000020D-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

nightVision

Properties

Type: nightVision
UUID: 0000011B-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events, Timed Write

Constants

Value String
0 "FALSE"
1 "TRUE"

nitrogenDioxideDensity

Properties

Type: nitrogenDioxideDensity
UUID: 000000C4-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

obstructionDetected

Properties

Type: obstructionDetected
UUID: 00000024-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

occupancyDetected

Properties

Type: occupancyDetected
UUID: 00000071-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "OCCUPANCY_NOT_DETECTED"
1 "OCCUPANCY_DETECTED"

on

Properties

Type: on
UUID: 00000025-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

operatingStateResponse

Properties

Type: operatingStateResponse
UUID: 00000232-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

opticalZoom

Properties

Type: opticalZoom
UUID: 0000011C-0000-1000-8000-0026BB765291
Format: float
Min Step: 0.1
Perms: Paired Read, Paired Write, Events

outletInUse

Properties

Type: outletInUse
UUID: 00000026-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

ozoneDensity

Properties

Type: ozoneDensity
UUID: 000000C3-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

pm10Density

Properties

Type: pm10Density
UUID: 000000C7-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

pm2_5Density

Properties

Type: pm2_5Density
UUID: 000000C6-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

pairSetup

Properties

Type: pairSetup
UUID: 0000004C-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

pairVerify

Properties

Type: pairVerify
UUID: 0000004E-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

pairingFeatures

Properties

Type: pairingFeatures
UUID: 0000004F-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read

pairingPairings

Properties

Type: pairingPairings
UUID: 00000050-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

passwordSetting

Properties

Type: passwordSetting
UUID: 000000E4-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Events, Paired Read, Paired Write

periodicSnapshotsActive

Properties

Type: periodicSnapshotsActive
UUID: 00000225-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "DISABLE"
1 "ENABLE"

pictureMode

Properties

Type: pictureMode
UUID: 000000E2-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 13
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "OTHER"
1 "STANDARD"
2 "CALIBRATED"
3 "CALIBRATED_DARK"
4 "VIVID"
5 "GAME"
6 "COMPUTER"
7 "CUSTOM"
8 "UNKNOWN8"
9 "UNKNOWN9"
10 "UNKNOWN10"
11 "UNKNOWN11"
12 "UNKNOWN12"
13 "UNKNOWN13"

ping

Properties

Type: ping
UUID: 0000023C-0000-1000-8000-0026BB765291
Format: data
Perms: Paired Read

positionState

Properties

Type: positionState
UUID: 00000072-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "DECREASING"
1 "INCREASING"
2 "STOPPED"

powerModeSelection

Properties

Type: powerModeSelection
UUID: 000000DF-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Write

Constants

Value String
0 "SHOW"
1 "HIDE"

productData

Properties

Type: productData
UUID: 00000220-0000-1000-8000-0026BB765291
Format: data
Perms: Paired Read

programMode

Properties

Type: programMode
UUID: 000000D1-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NO_PROGRAM_SCHEDULED"
1 "PROGRAM_SCHEDULED"
2 "PROGRAM_SCHEDULED_MANUAL_MODE"

programmableSwitchEvent

Properties

Type: programmableSwitchEvent
UUID: 00000073-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "SINGLE_PRESS"
1 "DOUBLE_PRESS"
2 "LONG_PRESS"

programmableSwitchOutputState

Properties

Type: programmableSwitchOutputState
UUID: 00000074-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

receivedSignalStrengthIndication

Properties

Type: receivedSignalStrengthIndication
UUID: 0000023F-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

receiverSensitivity

Properties

Type: receiverSensitivity
UUID: 00000244-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

recordingAudioActive

Properties

Type: recordingAudioActive
UUID: 00000226-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read, Paired Write, Events, Timed Write

Constants

Value String
0 "DISABLE"
1 "ENABLE"

relativeHumidityDehumidifierThreshold

Properties

Type: relativeHumidityDehumidifierThreshold
UUID: 000000C9-0000-1000-8000-0026BB765291
Format: float
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

relativeHumidityHumidifierThreshold

Properties

Type: relativeHumidityHumidifierThreshold
UUID: 000000CA-0000-1000-8000-0026BB765291
Format: float
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

relayControlPoint

Properties

Type: relayControlPoint
UUID: 0000005E-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events

relayEnabled

Properties

Type: relayEnabled
UUID: 0000005B-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

relayState

Properties

Type: relayState
UUID: 0000005C-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 5
Min Step: 1
Perms: Paired Read, Events

remainingDuration

Properties

Type: remainingDuration
UUID: 000000D4-0000-1000-8000-0026BB765291
Format: uint32
Max Value: 3600
Min Step: 1
Perms: Paired Read, Events

remoteKey

Properties

Type: remoteKey
UUID: 000000E1-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 16
Min Step: 1
Perms: Paired Write

Constants

Value String
0 "REWIND"
1 "FAST_FORWARD"
2 "NEXT_TRACK"
3 "PREVIOUS_TRACK"
4 "ARROW_UP"
5 "ARROW_DOWN"
6 "ARROW_LEFT"
7 "ARROW_RIGHT"
8 "SELECT"
9 "BACK"
10 "EXIT"
11 "PLAY_PAUSE"
12 "UNKNOWN12"
13 "UNKNOWN13"
14 "UNKNOWN14"
15 "INFORMATION"
16 "UNKNOWN16"

resetFilterIndication

Properties

Type: resetFilterIndication
UUID: 000000AD-0000-1000-8000-0026BB765291
Format: uint8
Min Value: 1
Max Value: 1
Min Step: 1
Perms: Paired Write

rotationDirection

Properties

Type: rotationDirection
UUID: 00000028-0000-1000-8000-0026BB765291
Format: int
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "CLOCKWISE"
1 "COUNTER_CLOCKWISE"

rotationSpeed

Properties

Type: rotationSpeed
UUID: 00000029-0000-1000-8000-0026BB765291
Format: float
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

routerStatus

Properties

Type: routerStatus
UUID: 0000020E-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Paired Read, Events

Constants

Value String
0 "READY"
1 "NOT_READY"

saturation

Properties

Type: saturation
UUID: 0000002F-0000-1000-8000-0026BB765291
Format: float
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

securitySystemAlarmType

Properties

Type: securitySystemAlarmType
UUID: 0000008E-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

securitySystemCurrentState

Properties

Type: securitySystemCurrentState
UUID: 00000066-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 4
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "STAY_ARM"
1 "AWAY_ARM"
2 "NIGHT_ARM"
3 "DISARMED"
4 "ALARM_TRIGGERED"

securitySystemTargetState

Properties

Type: securitySystemTargetState
UUID: 00000067-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "STAY_ARM"
1 "AWAY_ARM"
2 "NIGHT_ARM"
3 "DISARM"

selectedAudioStreamConfiguration

Properties

Type: selectedAudioStreamConfiguration
UUID: 00000128-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

selectedCameraRecordingConfiguration

Properties

Type: selectedCameraRecordingConfiguration
UUID: 00000209-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events

selectedRTPStreamConfiguration

Properties

Type: selectedRTPStreamConfiguration
UUID: 00000117-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

serialNumber

Properties

Type: serialNumber
UUID: 00000030-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

serviceLabelIndex

Properties

Type: serviceLabelIndex
UUID: 000000CB-0000-1000-8000-0026BB765291
Format: uint8
Min Value: 1
Max Value: 255
Min Step: 1
Perms: Paired Read

serviceLabelNamespace

Properties

Type: serviceLabelNamespace
UUID: 000000CD-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read

Constants

Value String
0 "DOTS"
1 "ARABIC_NUMERALS"

setDuration

Properties

Type: setDuration
UUID: 000000D3-0000-1000-8000-0026BB765291
Format: uint32
Max Value: 3600
Min Step: 1
Perms: Paired Read, Paired Write, Events

setupDataStreamTransport

Properties

Type: setupDataStreamTransport
UUID: 00000131-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

setupEndpoints

Properties

Type: setupEndpoints
UUID: 00000118-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

setupTransferTransport

Properties

Type: setupTransferTransport
UUID: 00000201-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Write, Write Response

signalToNoiseRatio

Properties

Type: signalToNoiseRatio
UUID: 00000241-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

siriInputType

Properties

Type: siriInputType
UUID: 00000132-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read

Constants

Value String
0 "PUSH_BUTTON_TRIGGERED_APPLE_TV"

slatType

Properties

Type: slatType
UUID: 000000C0-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read

Constants

Value String
0 "HORIZONTAL"
1 "VERTICAL"

sleepDiscoveryMode

Properties

Type: sleepDiscoveryMode
UUID: 000000E8-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NOT_DISCOVERABLE"
1 "ALWAYS_DISCOVERABLE"

sleepInterval

Properties

Type: sleepInterval
UUID: 0000023A-0000-1000-8000-0026BB765291
Format: uint32
Min Step: 1
Perms: Paired Read, Events

smokeDetected

Properties

Type: smokeDetected
UUID: 00000076-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "SMOKE_NOT_DETECTED"
1 "SMOKE_DETECTED"

softwareRevision

Properties

Type: softwareRevision
UUID: 00000054-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

statusActive

Properties

Type: statusActive
UUID: 00000075-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

statusFault

Properties

Type: statusFault
UUID: 00000077-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NO_FAULT"
1 "GENERAL_FAULT"

statusJammed

Properties

Type: statusJammed
UUID: 00000078-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NOT_JAMMED"
1 "JAMMED"

statusLowBattery

Properties

Type: statusLowBattery
UUID: 00000079-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "BATTERY_LEVEL_NORMAL"
1 "BATTERY_LEVEL_LOW"

statusTampered

Properties

Type: statusTampered
UUID: 0000007A-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NOT_TAMPERED"
1 "TAMPERED"

streamingStatus

Properties

Type: streamingStatus
UUID: 00000120-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

sulphurDioxideDensity

Properties

Type: sulphurDioxideDensity
UUID: 000000C5-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

supportedAudioRecordingConfiguration

Properties

Type: supportedAudioRecordingConfiguration
UUID: 00000207-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

supportedAudioStreamConfiguration

Properties

Type: supportedAudioStreamConfiguration
UUID: 00000115-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedCameraRecordingConfiguration

Properties

Type: supportedCameraRecordingConfiguration
UUID: 00000205-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

supportedDataStreamTransportConfiguration

Properties

Type: supportedDataStreamTransportConfiguration
UUID: 00000130-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedCharacteristicValueTransitionConfiguration

Properties

Type: supportedCharacteristicValueTransitionConfiguration
UUID: 00000144-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedDiagnosticsSnapshot

Properties

Type: supportedDiagnosticsSnapshot
UUID: 00000238-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedRTPConfiguration

Properties

Type: supportedRTPConfiguration
UUID: 00000116-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedRouterConfiguration

Properties

Type: supportedRouterConfiguration
UUID: 00000210-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedTransferTransportConfiguration

Properties

Type: supportedTransferTransportConfiguration
UUID: 00000202-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

supportedVideoRecordingConfiguration

Properties

Type: supportedVideoRecordingConfiguration
UUID: 00000206-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

supportedVideoStreamConfiguration

Properties

Type: supportedVideoStreamConfiguration
UUID: 00000114-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

swingMode

Properties

Type: swingMode
UUID: 000000B6-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "SWING_DISABLED"
1 "SWING_ENABLED"

targetAirPurifierState

Properties

Type: targetAirPurifierState
UUID: 000000A8-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "MANUAL"
1 "AUTO"

targetControlList

Properties

Type: targetControlList
UUID: 00000124-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Write, Paired Read, Write Response

targetControlSupportedConfiguration

Properties

Type: targetControlSupportedConfiguration
UUID: 00000123-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

targetDoorState

Properties

Type: targetDoorState
UUID: 00000032-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "OPEN"
1 "CLOSED"

targetFanState

Properties

Type: targetFanState
UUID: 000000BF-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "MANUAL"
1 "AUTO"

targetHeaterCoolerState

Properties

Type: targetHeaterCoolerState
UUID: 000000B2-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "AUTO"
1 "HEAT"
2 "COOL"

targetHeatingCoolingState

Properties

Type: targetHeatingCoolingState
UUID: 00000033-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "OFF"
1 "HEAT"
2 "COOL"
3 "AUTO"

targetHorizontalTiltAngle

Properties

Type: targetHorizontalTiltAngle
UUID: 0000007B-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Paired Write, Events

targetHumidifierDehumidifierState

Properties

Type: targetHumidifierDehumidifierState
UUID: 000000B4-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "HUMIDIFIER_OR_DEHUMIDIFIER"
1 "HUMIDIFIER"
2 "DEHUMIDIFIER"

targetMediaState

Properties

Type: targetMediaState
UUID: 00000137-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "PLAY"
1 "PAUSE"
2 "STOP"

targetPosition

Properties

Type: targetPosition
UUID: 0000007C-0000-1000-8000-0026BB765291
Format: uint8
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

targetRelativeHumidity

Properties

Type: targetRelativeHumidity
UUID: 00000034-0000-1000-8000-0026BB765291
Format: float
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

targetTemperature

Properties

Type: targetTemperature
UUID: 00000035-0000-1000-8000-0026BB765291
Format: float
Unit: celsius
Min Value: 10
Max Value: 38
Min Step: 0.1
Perms: Paired Read, Paired Write, Events

targetTiltAngle

Properties

Type: targetTiltAngle
UUID: 000000C2-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Paired Write, Events

targetVerticalTiltAngle

Properties

Type: targetVerticalTiltAngle
UUID: 0000007D-0000-1000-8000-0026BB765291
Format: int
Unit: arcdegrees
Min Value: -90
Max Value: 90
Min Step: 1
Perms: Paired Read, Paired Write, Events

targetVisibilityState

Properties

Type: targetVisibilityState
UUID: 00000134-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "SHOWN"
1 "HIDDEN"

temperatureDisplayUnits

Properties

Type: temperatureDisplayUnits
UUID: 00000036-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Read, Paired Write, Events

Constants

Value String
0 "CELSIUS"
1 "FAHRENHEIT"

thirdPartyCameraActive

Properties

Type: thirdPartyCameraActive
UUID: 0000021C-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read, Events

Constants

Value String
0 "OFF"
1 "ON"

transmitPower

Properties

Type: transmitPower
UUID: 00000242-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

MaximumTransmitPower

Properties

Type: MaximumTransmitPower
UUID: 00000243-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read

tunnelConnectionTimeout

Properties

Type: tunnelConnectionTimeout
UUID: 00000061-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Write, Paired Read, Events

tunneledAccessoryAdvertising

Properties

Type: tunneledAccessoryAdvertising
UUID: 00000060-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Write, Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

tunneledAccessoryConnected

Properties

Type: tunneledAccessoryConnected
UUID: 00000059-0000-1000-8000-0026BB765291
Format: bool
Perms: Paired Write, Paired Read, Events

Constants

Value String
0 "FALSE"
1 "TRUE"

tunneledAccessoryStateNumber

Properties

Type: tunneledAccessoryStateNumber
UUID: 00000058-0000-1000-8000-0026BB765291
Format: int
Perms: Paired Read, Events

vocDensity

Properties

Type: vocDensity
UUID: 000000C8-0000-1000-8000-0026BB765291
Format: float
Max Value: 1000
Min Step: 1
Perms: Paired Read, Events

valveType

Properties

Type: valveType
UUID: 000000D5-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "GENERIC_VALVE"
1 "IRRIGATION"
2 "SHOWER_HEAD"
3 "WATER_FAUCET"

version

Properties

Type: version
UUID: 00000037-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

videoAnalysisActive

Properties

Type: videoAnalysisActive
UUID: 00000229-0000-1000-8000-0026BB765291
Format: uint8
Perms: Paired Read, Paired Write, Events

volume

Properties

Type: volume
UUID: 00000119-0000-1000-8000-0026BB765291
Format: uint8
Unit: percentage
Max Value: 100
Min Step: 1
Perms: Paired Read, Paired Write, Events

volumeControlType

Properties

Type: volumeControlType
UUID: 000000E9-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 3
Min Step: 1
Perms: Paired Read, Events

Constants

Value String
0 "NONE"
1 "RELATIVE"
2 "RELATIVE_WITH_CURRENT"
3 "ABSOLUTE"

volumeSelector

Properties

Type: volumeSelector
UUID: 000000EA-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Min Step: 1
Perms: Paired Write

Constants

Value String
0 "INCREMENT"
1 "DECREMENT"

wanConfigurationList

Properties

Type: wanConfigurationList
UUID: 00000211-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

wanStatusList

Properties

Type: wanStatusList
UUID: 00000212-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

wakeConfiguration

Properties

Type: wakeConfiguration
UUID: 00000222-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

waterLevel

Properties

Type: waterLevel
UUID: 000000B5-0000-1000-8000-0026BB765291
Format: float
Max Value: 100
Min Step: 1
Perms: Paired Read, Events

wifiCapabilities

Properties

Type: wifiCapabilities
UUID: 0000022C-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read

wifiConfigurationControl

Properties

Type: wifiConfigurationControl
UUID: 0000022D-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Events, Timed Write, Write Response

wifiSatelliteStatus

Properties

Type: wifiSatelliteStatus
UUID: 0000021E-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 2
Perms: Paired Read, Events

Constants

Value String
0 "UNKNOWN"
1 "CONNECTED"
2 "NOT_CONNECTED"

assetUpdateReadiness

Properties

Type: assetUpdateReadiness
UUID: 00000269-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read, Events

supportedAssetTypes

Properties

Type: supportedAssetTypes
UUID: 00000268-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read

configurationState

Properties

Type: configurationState
UUID: 00000263-0000-1000-8000-0026BB765291
Format: uint16
Perms: Paired Read, Events

NFCAccessControlPoint

Properties

Type: NFCAccessControlPoint
UUID: 00000264-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

NFCAccessSupportedConfiguration

Properties

Type: NFCAccessSupportedConfiguration
UUID: 00000265-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

SiriEndpointSessionStatus

Properties

Type: SiriEndpointSessionStatus
UUID: 00000254-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Events

threadControlPoint

Properties

Type: threadControlPoint
UUID: 00000704-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Write

threadNodeCapabilities

Properties

Type: threadNodeCapabilities
UUID: 00000702-0000-1000-8000-0026BB765291
Format: uint16
Max Value: 31
Min Step: 1
Perms: Paired Read

threadStatus

Properties

Type: threadStatus
UUID: 00000703-0000-1000-8000-0026BB765291
Format: uint16
Max Value: 6
Min Step: 1
Perms: Paired Read, Events

threadOpenThreadVersion

Properties

Type: threadOpenThreadVersion
UUID: 00000706-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

accessCodeControlPoint

Properties

Type: accessCodeControlPoint
UUID: 00000262-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write, Write Response

accessCodeSupportedConfiguration

Properties

Type: accessCodeSupportedConfiguration
UUID: 00000261-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

airPlayEnable

Properties

Type: airPlayEnable
UUID: 0000025B-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read, Paired Write

characteristicValueActiveTransitionCount

Properties

Type: characteristicValueActiveTransitionCount
UUID: 0000024B-0000-1000-8000-0026BB765291
Format: uint8
Perms: Events, Paired Read

cryptoHash

Properties

Type: cryptoHash
UUID: 00000250-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Write, Write Response

firmwareUpdateReadiness

Properties

Type: firmwareUpdateReadiness
UUID: 00000234-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Events, Paired Read

firmwareUpdateStatus

Properties

Type: firmwareUpdateStatus
UUID: 00000235-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Events, Paired Read

hardwareFinish

Properties

Type: hardwareFinish
UUID: 0000026C-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

MetricsBufferFullState

Properties

Type: MetricsBufferFullState
UUID: 00000272-0000-1000-8000-0026BB765291
Format: bool
Perms: Events, Paired Read

multiFunctionButton

Properties

Type: multiFunctionButton
UUID: 0000026B-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read

selectedDiagnosticsModes

Properties

Type: selectedDiagnosticsModes
UUID: 0000024D-0000-1000-8000-0026BB765291
Format: uint32
Perms: Paired Read, Paired Write

selectedSleepConfiguration

Properties

Type: selectedSleepConfiguration
UUID: 00000252-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Events, Paired Read, Paired Write, Write Response

siriEnable

Properties

Type: siriEnable
UUID: 00000255-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read, Paired Write

siriEngineVersion

Properties

Type: siriEngineVersion
UUID: 0000025A-0000-1000-8000-0026BB765291
Format: string
Perms: Paired Read

siriLightOnUse

Properties

Type: siriLightOnUse
UUID: 00000258-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read, Paired Write

siriListening

Properties

Type: siriListening
UUID: 00000256-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read, Paired Write

siriTouchToUse

Properties

Type: siriTouchToUse
UUID: 00000257-0000-1000-8000-0026BB765291
Format: uint8
Max Value: 1
Perms: Events, Paired Read, Paired Write

StagedFirmwareVersion

Properties

Type: StagedFirmwareVersion
UUID: 00000249-0000-1000-8000-0026BB765291
Format: string
Perms: Events, Paired Read

supportedMetrics

Properties

Type: supportedMetrics
UUID: 00000271-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read, Paired Write

supportedFirmwareUpdateConfiguration

Properties

Type: supportedFirmwareUpdateConfiguration
UUID: 00000233-0000-1000-8000-0026BB765291
Format: tlv8
Perms: Paired Read

tapType

Properties

Type: tapType
UUID: 0000022F-0000-1000-8000-0026BB765291
Format: uint16
Perms: Paired Read

token

Properties

Type: token
UUID: 00000231-0000-1000-8000-0026BB765291
Format: data
Perms: Paired Write

CMD4 Directives

These directives appear within the "Cmd4" plugin header and reflect how Cmd4 will behave overall.

Cmd4DirectiveTypeDefaultDescription
debug < Bool > false Output Debug messages. Can also be accomplished with setenv DEBUG=Cmd4
outputConstants < Bool > false If Cmd4 will send Strings like "TRUE" or "FALSE" instead of 0 | 1 for all Accessories
statusMsg < Bool > TRUE Cmd4 will log a Set Status Message for all Accessories.
interval interval 60 < seconds > How long before killing the state command of all polled characteristics. See interval in Accessory Directives for full description as it can also be set per accessory or per characteristic.
timeout timeout 60000 < msec > How long before killing the state command of all polled characteristics. See timeout in Accessory Directives for full description as it can also be set per accessory or per characteristic.
queueTypes < Array of { "queue": < "SomeName" >, "queueType": < "Sequential" | "WoRm" > "retries": < 0 > } none Pre-defines Queue types. This Directive can also be per queue as noted by its presence as an accessory directive.
definitions < Array > An Array of new Characteristic Objects. See Custom Characteristics, around line 339 for more information

CMD4 Accessory Directives

These directives appear within the characteristic section of the Cmd4 Accessory

Cmd4DirectiveTypeDefaultDescription
subType < unique string > accessory.name Used to distinguish accessories that have same Type and Name.
outputConstants < Bool > false If Cmd4 will send Strings like "TRUE" or "FALSE" instead of 0 | 1
statusMsg < Bool > TRUE Cmd4 will log a Set Status Message
publishExternally < Bool > false Tell Homebridge to publish the device as its own bridge.
stateChangeResponseTime < seconds > 60 How long to wait between a Set and Get command.
interval < seconds > 60 < seconds > How long between polls of all polled characteristics.
timeout < msec > 60000 < msec > How long before killing the state command of all polled characteristics.
polling < Bool > false If the characteristics should be polled for state change.
or [{"characteristic" < characteristic >, [ "interval": < sec >, "timeout": < msec > ] }] The timeout and interval override any higher directive.
queue queue < String > Defines which Queue polled characteristics will be placed.
state_cmd < state_cmd > See Description The command used to Get/Set Device characteristic State.
The state_cmd represents the path to your script. Cmd4 appends the Get/Set shown.
state_cmd Get < DisplayName > < characteristic >
state_cmd Set < DisplayName > < characteristic > < value >
state_cmd_prefix < String > A String prepended to the < state_cmd >.
state_cmd_suffix < String > A String appended to the < state_cmd >.
props < Bool > false A way to override Hap Characteristiic Properties
Only used to set min/max temperatures, for instance:
"props" : { "currentTemperature": { "maxValue":100, "minValue": -100, "minStep": 0.1}}
category < CATEGORY > See Homebridge Categories for a complete list of possible categories.
fakegato < JSON > See the section, "Adding in Fakegato history" below.
linkedTypes < JSON > Other Cmd4 Accessories like Input Source for HDMI inputs.

Custom Characteristics

These directives appear within the Cmd4 Platform section


IMPORTANT - It is unlikely that adding custom characteristics will be supported by any GUI or SIRI


Custom characteristics in Cmd4 do not stray far from how Homebridge uses them from HAP-NodeJS. To create a custom characteristic an object entry is programmatically added to lib/CMD4_ACC_TYPE_ENUM.js via an entry you define in your config.json. The best way to show how to define a custom characteristic is through an example

.
            {
               "platform": "Cmd4",
               "outputConstants": false,
               "statusMsg": true,
               "Definitions": [
                  { "type": "PointX",
                    "description": "An X Coordinate",
                    "props": { "format": "uint32",
                               "minValue": 0,
                               "minStep": 1,
                               "perms": [ "ev", "pr", "pw" ]
                             }
                  }
               ],
               "accessories": [
                  { "type": "Switch",
                    "name": "PS_4",
                    "PointX": 3267,
                    "on": false,
                    "polling": [ { "characteristic": "on", "interval": 50 },
                                 { "characteristic": "pointX", "interval": 5 }
                               ],
                    "state_cmd": "node .homebridge/Cmd4Scripts/AnyDevice.js"
                  }
               ]
            }
         


The definitions for "props" can be found at: HAP Characteristics - line 259

Example Cmd4 JavaScript Template

This script is auto generated from: ./Extras/Cmd4Scripts/Examples/ExampleJavaScript_template.js

#!/usr/bin/env node
//  ExampleScript_template.js
//
// Description:
//   This script is a goood starting place for you to create Cmd4 Scripts
//   of your own
//
// Parameters are:
//    Get < Any accessory name > < Characteristic >
//    Set < Any accessory name > < Characteristic > < value >
//
// Note 1: These paramaters match the those of the Cmd4 plugin.
//         A full lost of supported devices and characteristics can be
//         found at:
//         https://ztalbot2000.github.io/homebridge-cmd4
//
// How it works:
//    The Cmd4 plugin will call this script to retrieve those states
//    you have defined as not Cached to Get/Set your devices characteristic
//    states.
//
//    For example:
//       node ExampleScript_template.js Set My_Door TargetDoorState 0
//     or
//       node ExampleScript.js Get My_Door CurrentDoorState
//
//

'use strict';

var length = process.argv.length;
var device = "My_Door";
var io = "";
var characteristic = "";
var option = "";

if ( length == 2 ) process.exit( 0 );

if ( length <= 2 ) {
    console.log( "Usage: " + process.argv[0] + " < Get > < AccessoryName > < Characteristic >" );
    console.log( "       " + process.argv[0] + " < Set > < AccessoryName > < Characteristic > < Value >" );
    process.exit( -1 );
}

if ( length >= 2 ) io = process.argv[2];
if ( length >= 3 ) device = process.argv[3];
if ( length >= 4 ) characteristic  = process.argv[4];
if ( length >= 5 ) option  = process.argv[5];

var c = "";

switch( io )
{
    case "Get":
    {
        switch( characteristic )
        {
            case "CurrentDoorState":
            {
               console.log( 0 );

               // See https://ztalbot2000.github.io/homebridge-cmd4
               // For the possible values and characteristics
               // available per device. It will show somethink like:
               // Valid Values:
               // 0 - "Open. The door is fully open."
               // 1 - "Closed. The door is fully closed."
               // 2 - "Opening. The door is actively opening."
               // 3 - "Closing. The door is actively closing."
               // 4 - "Stopped. The door is not moving, and it is not fully
               //      open nor fully closed."
               // 5-255 - "Reserved"

               break;
            }
            case "TargetDoorState":
            {
                console.log( 0 );
                break;
            }
            case "ObstructionDetected":
            {
                console.log ( 0 );
                break;
            }
            case "LockCurrentState":
            {
                console.log ( 0 );
                break;
            }
            default:
                console.error( "Unhandled characteristic for:"  + io  +  " Device:" + device  +  " Characteristic:" + characteristic );
                process.exit( -1 );
        }

        break;

    } // End of Switch for "Get"
    case "Set":
    {
        switch( characteristic )
        {
            case "CurrentDoorState":
            {
               // Current Door State is not settable. The
               // call would be to TargetDoorState. This is here
               // for debugging only.

               break;
            }
            case "TargetDoorState":
            {
                // Do something of your own here.

                break;
            }
            case "ObstructionDetected":
            {
               // Obstruction Detected is not settable. It
               // call is a read-only characteristic. This is here
               // for debugging only.
               break;
            }
            case "LockCurrentState":
            {
                // Lock Current State is not settable. It
                // call is a read-only characteristic. This is here
                // for debugging only.
                break;
            }
            default:
                console.error( "UnHandled Characteristic for:"  + io  +  " Device:" + device  +  " Characteristic:" + characteristic );
                process.exit( -1 );
        }

        break;
    } // End of Switch Device for "Set"
    default:
        console.error( "Unknown IO" + io );
        process.exit( -1 );
}

//console.log( "Say What Device:" + device + " Characteristic:" + characteristic + " Option:" + option );

// You must exit with a zero status, confirming the script rannsuccessfully.
process.exit( 0 );


         

Example Cmd4 Shell Script Template

This script is auto generated from: ./Extras/Cmd4Scripts/Examples/ExampleShellScript_template.sh

#!/bin/bash

#  ExampleScript_template.sh
#
# Description:
#   This script is a goood starting place for you to create Cmd4 Scripts
#   of your own
#
# Parameters are:
#    Get < Any accessory name > < Characteristic>
#    Set < Any accessory name > < Characteristic> < value >
#
# Note 1: These paramaters match the those of the Cmd4 plugin.
#         A full lost of supported devices and characteristics can be
#         found at:
#         https://ztalbot2000.github.io/homebridge-cmd4
#
# How it works:
#
#    The Cmd4 plugin will call this script to retrieve those states
#    you have defined as not Cached to Get/Set your devices characteristic
#    states.
#
#    For example:
#       bash ExampleScript_template.sh Set My_Door TargetDoorState 0
#     or
#       bash ExampleScript.sh Get My_Door CurrentDoorState
#

set -e

# Exit immediately for unbound variables.
set -u


length=$#
device=""
io=""
characteristic=""
option=""

if [ $length -le 1 ]; then
   printf "Usage: $0 Get < AccessoryName > < Characteristic >\n"
   printf "Usage: $0 Set < AccessoryName > < Characteristic > < Value >\n"
   exit -1
fi

# printf "args =$#\n"   # debug
# printf "arg1 =$1\n"   # debug

if [ $length -ge 1 ]; then
    io=$1
    # printf "io=$io\n"   # debug
fi
if [ $length -ge 2 ]; then
    device=$2
    # printf "device = ${device}\n"   # debug
fi
if [ $length -ge 3 ]; then
    characteristic=$3
    # printf "Characteristic = ${characteristic}\n"   # debug
fi
if [ $length -ge 4 ]; then
    option=$4
    # printf "option = ${option}\n"   # debug
fi

if [ "${io}" == "Get" ]; then
   case $characteristic in
      'CurrentDoorState')

         printf "0\n"          # Door is open

         # See https://ztalbot2000.github.io/homebridge-cmd4
         # For the possible values and characteristics
         # available per device. It will show somethink like:
         # Valid Values:
         # 0 - "Open. The door is fully open."
         # 1 - "Closed. The door is fully closed."
         # 2 - "Opening. The door is actively opening."
         # 3 - "Closing. The door is actively closing."
         # 4 - "Stopped. The door is not moving, and it is not fully
         #      open nor fully closed."
         # 5-255 - "Reserved"
         exit 0
         ;;
      'TargetDoorState')
         printf "0\n"
         exit 0
         ;;
      'ObstructionDetected')
         printf "0\n"
         exit 0
         ;;
      'LockCurrentState')
         printf "0\n"
         exit 0
         ;;
      *)
         printf "UnHandled Get ${device}  Characteristic ${characteristic}\n"
         exit -1
         ;;
    esac
fi
if [ "${io}" == 'Set' ]; then
   case $characteristic in
      'CurrentDoorState')
         # Current Door State is not settable. The
         # call would be to TargetDoorState. This is here
         # for debugging only.

         exit 0
         ;;
      'TargetDoorState')
         # Do something of your own here.
         exit 0
         ;;
      'ObstructionDetected')
         # Obstruction Detected is not settable. It
         # call is a read-only characteristic. This is here
         # for debugging only.
         exit 0
         ;;
      'LockCurrentState')
         # Lock Current State is not settable. It
         # call is a read-only characteristic. This is here
         # for debugging only.
         exit 0
         ;;
      *)
         printf "UnHandled Set GarageDoorOpenner Characteristic ${characteristic}"
         exit -1
         ;;
    esac
fi
printf "Unknown io command ${io}\n"
exit -1