Clipsal C-Bus Guia do Utilizador descarregar pdf (Página 41)

cbus Documentation, Release 0.1-dev

Parameters line (str) – CBus event data

Returns Remaining unparsed data (str) or None on error.

Return type str or NoneType

delimiter = ‘\r\n’

identify(unit_address, attribute)

Sends an IDENTIFY command to the given unit_address.

Parameters

• unit_address (int) – Unit address to send the packet to

• attribute (int) – Attribute ID to retrieve information for. See s7.2 of Serial Interface Guide

for acceptable codes.

Returns Single-byte string with code for the conﬁrmation event.

Return type string

lighting_group_off(group_addr)

Turns off the lights for the given group_id.

Parameters group_addr (int, or iterable of ints of length <= 9.) – Group address(es) to turn

the lights off for, up to 9.

Returns Single-byte string with code for the conﬁrmation event.

Return type string

lighting_group_on(group_addr)

Turns on the lights for the given group_id.

Parameters group_addr (int, or iterable of ints of length <= 9.) – Group address(es) to turn

the lights on for, up to 9.

Returns Single-byte string with code for the conﬁrmation event.

Return type string

lighting_group_ramp(group_addr, duration, level=1.0)

Ramps (fades) a group address to a speciﬁed lighting level.

Note: CBus only supports a limited number of fade durations, in decreasing accuracy up to 17 minutes

(1020 seconds). Durations longer than this will throw an error.

A duration of 0 will ramp “instantly” to the given level.

Parameters

• group_addr (int) – The group address to ramp.

• duration (int) – Duration, in seconds, that the ramp should occur over.

• level (ﬂoat) – An amount between 0.0 and 1.0 indicating the brightness to set.

Returns Single-byte string with code for the conﬁrmation event.

Return type string

lighting_group_terminate_ramp(group_addr)

Stops ramping a group address at the current point.

Parameters group_addr (int) – Group address to stop ramping of.

Returns Single-byte string with code for the conﬁrmation event.

8.1. cbus Package 37

1 2 ... 36 37 38 39 40 41 42 43 44 45 46 ... 59 60

Sem comentários

Clipsal C-Bus Guia do Utilizador Página 41