Characteristic

Characteristic Base class for a HAP Accessory Service.

See also

pyhap.service.Service

class pyhap.characteristic.Characteristic(display_name, type_id, properties, allow_invalid_client_values=False, unique_id=None)

Represents a HAP characteristic, the smallest unit of the smart home.

A HAP characteristic is some measurement or state, like battery status or the current temperature. Characteristics are contained in services. Each characteristic has a unique type UUID and a set of properties, like format, min and max values, valid values and others.

client_update_value(value, sender_client_addr=None)

Called from broker for value change in Home app.

Change self.value to value and call callback.

classmethod from_dict(name, json_dict, from_loader=False)

Initialize a characteristic object from a dict.

Parameters:json_dict (dict) – Dictionary containing at least the keys Format, Permissions and UUID

get_value()

This is to allow for calling getter_callback

Returns:Current Characteristic Value

notify(sender_client_addr=None)

Notify clients about a value change. Sends the value.

See also

accessory.publish

See also

accessory_driver.publish

override_properties(properties=None, valid_values=None)

Override characteristic property values and valid values.

Parameters:

• properties (dict) – Dictionary with values to override the existing properties. Only changed values are required.
• valid_values (dict) – Dictionary with values to override the existing valid_values. Valid values will be set to new dictionary.

set_value(value, should_notify=True)

Set the given raw value. It is checked if it is a valid value.

If not set_value will be aborted and an error message will be displayed.

Characteristic.setter_callback You may also define a setter_callback on the Characteristic. This will be called with the value being set as the arg.

See also

Characteristic.value

Parameters:

• value (Depends on properties["Format"]) – The value to assign as this Characteristic’s value.
• should_notify (bool) – Whether a the change should be sent to subscribed clients. Notify will be performed if the broker is set.

to_HAP()

Create a HAP representation of this Characteristic.

Used for json serialization.

Returns:A HAP representation. Return type:dict

to_valid_value(value)

Perform validation and conversion to valid value.

valid_value_or_raise(value)

Raise ValueError if PROP_VALID_VALUES is set and the value is not present.