BPAPI Methods

BPAPI method Device/TurnOff

Device/TurnOff

Turns off the devices identified by {id}

Authorization required: Yes

HTTP methods allowed: GET, POST

Syntax: Device/{id}/TurnOff/  Details 

Turns off the devices identified by {id}

Equivalent to Device/AddProperty with parameters switch_mode 0


{id} may be any of node_id, user_defined_name, user_defined_group_name and bpapi_device_id
See Device for more information about what kind of id's that can be used

For confirmation that the command has been executed on the Gateway, use
Device/Property like this: Device/{id}/Property/switch_mode/value
and check that the returned scalar_value has been set to 0 (Off).

See also Device/TurnOn, -Gateway/TurnOn- and -Gateway/TurnOff-

Unit-tests: 1 test(s)

Popularity: 946090 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2025-12-06 05:04