caspia.meadow.rules package

Submodules

caspia.meadow.rules.base module

class caspia.meadow.rules.base.Rule(identifier=None, name=None)

Bases: caspia.meadow.serialization.Serializable, caspia.meadow.serialization.Deserializable

Subclasses must call super().__init__ after their initialization !!!

build_identifier()

Builds unique identifier for this rule.

classmethod deserialize(data, context)

enable_duplicates = False

property identifier

serialize()

Return serialized version (most likely dict) if possible or None.

serialize_content()

Subclasses should override this and return serialized self. If the instance cannot be serialized, return None. identifer key must not be included.

serialized_type = None

caspia.meadow.rules.handler module

caspia.meadow.rules.handler.rule_handler(rule)

When an anonymous rule is created, this handler should be called so the rule can be handled elsewhere

caspia.meadow.rules.lightgroup module

class caspia.meadow.rules.lightgroup.LightGroupAttachRule(group, light, identifier=None, name=None)

Bases: caspia.meadow.rules.base.Rule, caspia.meadow.serialization.Serializable, caspia.meadow.serialization.Deserializable

Subclasses must call super().__init__ after their initialization !!!

build_identifier()

Builds unique identifier for this rule.

classmethod deserialize(data, context)

enable_duplicates = False

property identifier

serialize()

Return serialized version (most likely dict) if possible or None.

serialize_content()

Subclasses should override this and return serialized self. If the instance cannot be serialized, return None. identifer key must not be included.

serialized_type = 'light-group-attach'

caspia.meadow.rules.on_do module

class caspia.meadow.rules.on_do.OnDoRule(on, do, trigger=<OnDoRuleTrigger.ON_TRUE: 'on_true'>, identifier=None, name=None)

Bases: caspia.meadow.rules.base.Rule, caspia.meadow.serialization.Serializable, caspia.meadow.serialization.Deserializable

Subclasses must call super().__init__ after their initialization !!!

build_identifier()

Builds unique identifier for this rule.

classmethod deserialize(data, context)

enable_duplicates = True

property identifier

serialize()

Return serialized version (most likely dict) if possible or None.

serialize_content()

Subclasses should override this and return serialized self. If the instance cannot be serialized, return None. identifer key must not be included.

serialized_type = 'on-do'

class caspia.meadow.rules.on_do.OnDoRuleTrigger

Bases: enum.Enum

An enumeration.

ON_TRUE = 'on_true'

ON_UPDATE = 'on_update'

caspia.meadow.rules.thermostat module

class caspia.meadow.rules.thermostat.ThermostatRule(identifier, temperature: caspia.reactive.observable.Observable[float][float], heating: caspia.reactive.observers.Observer, params: dict)

Bases: caspia.meadow.rules.base.Rule

Identifier will become the Thermostat’s service name. Name of the rule will be filled automatically.

build_identifier()

Builds unique identifier for this rule.

classmethod deserialize(data, context)

enable_duplicates = False

property identifier

serialize()

Return serialized version (most likely dict) if possible or None.

serialize_content()

Subclasses should override this and return serialized self. If the instance cannot be serialized, return None. identifer key must not be included.

serialized_type = None

Module contents