Free@home local API samples

For a blind/shutter actuator you need to search for a device with a channel that has a functionID with a value of "0009" (Shutter actuator, see the reference for a list of all valid function ids), "0061" (Blind actuator), "0062" (Attic window actuator) or "0063" (Awning actuator) depending on the device configuration.

On the selected channel search for an input datapoint with pairingID == 35 (Moves the sunblinds into a specified position, see the reference for a list of all valid pairing ids). To this datapoint you send a percent value to control the position of the blind.

The other method is to send command to move the blind up or down and send a stop command when done. The pairingId == 32 (Move sunblind up / down) input datapoint gets the value "0" to move up or "1" to move down. When the blind is in the desired position send "0" to the input datapoint with pairingID == 33 (Stops the sunblinds and to step it up/down) to stop it.

There is an output datapoint with pairingID == 288 (indicate the move up/down and stop state) shows the current movement, see in the table below for possible values. Another output datapoint (289 Indicate the current position of the sunblinds in percentage) represents the current position in percent. But note, that its not necessarly updated during the movement.

Relevant IDs and values

For channels:

See also the reference for a list of all valid IDs.

Example

Move the blind to 50%:

curl -X PUT \ 
  --user USERNAME:PASSWORD \ 
  https://192.168.2.1/fhapi/v1/api/rest/datapoint/00000000-0000-0000-0000-000000000000/ABB700C886B5.ch0003.idp0002 
  -d 50

Move the blind up:

curl -X PUT \ 
  --user USERNAME:PASSWORD \ 
  https://192.168.2.1/fhapi/v1/api/rest/datapoint/00000000-0000-0000-0000-000000000000/ABB700C886B5.ch0003.idp0000 \ 
  -d 0

Stop moving:

curl -X PUT \ 
  --user USERNAME:PASSWORD \ 
  https://192.168.2.1/fhapi/v1/api/rest/datapoint/00000000-0000-0000-0000-000000000000/ABB700C886B5.ch0003.idp0001 \ 
  -d 0

Query for current moving state:

curl -X GET \ 
  --user USERNAME:PASSWORD \ 
  https://192.168.2.1/fhapi/v1/api/rest/datapoint/00000000-0000-0000-0000-000000000000/ABB700C886B5.ch0003.odp0000

May return that its moving down:

{ 
  "00000000-0000-0000-0000-000000000000": 
    { 
      "values":["3"] 
    } 
}

Query for current position:

curl -X GET \ 
  --user USERNAME:PASSWORD \ 
  https://192.168.2.1/fhapi/v1/api/rest/datapoint/00000000-0000-0000-0000-000000000000/ABB700C886B5.ch0003.odp0001

Returns 0% as position:

{ 
  "00000000-0000-0000-0000-000000000000": 
    { 
      "values":["0"] 
    } 
}