caspia.meadow package

Subpackages

• caspia.meadow.cli package
  • Submodules
  • caspia.meadow.cli.shell module
  • caspia.meadow.cli.utils module
  • Module contents
• caspia.meadow.client package
  • Subpackages
    • caspia.meadow.client.connection package
      • Submodules
      • caspia.meadow.client.connection.connection module
      • caspia.meadow.client.connection.consumer module
      • caspia.meadow.client.connection.gateway module
      • caspia.meadow.client.connection.subscriber module
      • Module contents
  • Submodules
  • caspia.meadow.client.browser module
  • caspia.meadow.client.consumer module
  • caspia.meadow.client.gateway module
  • Module contents
• caspia.meadow.metadata package
  • Submodules
  • caspia.meadow.metadata.provider module
  • caspia.meadow.metadata.store module
  • Module contents
• caspia.meadow.rules package
  • Submodules
  • caspia.meadow.rules.base module
  • caspia.meadow.rules.handler module
  • caspia.meadow.rules.lightgroup module
  • caspia.meadow.rules.on_do module
  • caspia.meadow.rules.thermostat module
  • Module contents
• caspia.meadow.services package
  • Subpackages
    • caspia.meadow.services.meters package
      • Submodules
      • caspia.meadow.services.meters.electricity module
      • Module contents
    • caspia.meadow.services.sensors package
      • Submodules
      • caspia.meadow.services.sensors.carbondioxide module
      • caspia.meadow.services.sensors.humidity module
      • caspia.meadow.services.sensors.light module
      • caspia.meadow.services.sensors.motion module
      • caspia.meadow.services.sensors.noise module
      • caspia.meadow.services.sensors.temperature module
      • Module contents
  • Submodules
  • caspia.meadow.services.base module
  • caspia.meadow.services.blinds module
  • caspia.meadow.services.blindscontrol module
  • caspia.meadow.services.button module
  • caspia.meadow.services.characteristic module
  • caspia.meadow.services.display module
  • caspia.meadow.services.door module
  • caspia.meadow.services.fan module
  • caspia.meadow.services.irrigation module
  • caspia.meadow.services.light module
  • caspia.meadow.services.lockmechanism module
  • caspia.meadow.services.metadataprovider module
  • caspia.meadow.services.outlet module
  • caspia.meadow.services.presence module
  • caspia.meadow.services.pump module
  • caspia.meadow.services.serial module
  • caspia.meadow.services.sun module
  • caspia.meadow.services.switch module
  • caspia.meadow.services.thermostat module
  • caspia.meadow.services.weather module
  • caspia.meadow.services.window module
  • Module contents
• caspia.meadow.testing namespace
  • Submodules
  • caspia.meadow.testing.connection module
• caspia.meadow.value package
  • Submodules
  • caspia.meadow.value.serialization module
  • caspia.meadow.value.validators module
  • Module contents

Submodules

caspia.meadow.do_shortcut module

caspia.meadow.errors module

exception caspia.meadow.errors.CommunicationError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError

args

code = 4

extra = {}

static from_dict(data)

static from_exception(exc)

static from_mqtt(mqtt_err_no)

message = 'communication error'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.InvalidValueError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError

args

code = 2

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'invalid value'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.MeadowError(message=None, code=None, **extra)

Bases: Exception

Represents an error within the Meadow protocol

args

code = -1

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'unknown error'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.NotAvailableError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError

args

code = 5

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'resource not available'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.NotReadyError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError, caspia.reactive.errors.ValueNotReady

args

code = 3

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'not ready'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.NotSupportedError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError

args

code = 1

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'not supported'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception caspia.meadow.errors.SensorFailureError(message=None, code=None, **extra)

Bases: caspia.meadow.errors.MeadowError

args

code = 101

extra = {}

static from_dict(data)

static from_exception(exc)

message = 'sensor failure'

to_dict()

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

caspia.meadow.lookup module

class caspia.meadow.lookup.ActiveNamespace(lookup, path)

Bases: object

property full_path

class caspia.meadow.lookup.Lookup(create=None, prepare=None)

Bases: object

This class works as a collection of known services.

add(service)

Register given service within this lookup instance.

add_create_hook(func)

Register a new service creator. When user requests a service from this lookup and the service is not known, the lookup tries to create it registered creators. Creator is a callable creator(service_type, service_name) -> None|Service.

add_prepare_hook(func)

Register a hook (function) to be called with every new service instance added to this lookup. :param func: The function hook with signature func(new_service).

find(name, type=None)

Find service with given name (and optionally type).

get(name, type=None, create=True)

Get service of a given type and name. Try to create it, if create is True

namespace(path)

Return object, which if used as a context manager enables use of relative names. :Example:

with lookup.namespace(‘basement’):

lookup.get(‘light’, ‘.light’) # gets service named basement.light

resolve_name(name)

Resolve name with respect to active namespaces.

caspia.meadow.name module

caspia.meadow.name.match(name, pattern, *, type=None) → Optional[str]

Match the name against a pattern.

Parameters

• name – the name to match

• pattern – the name pattern

• type – optional type to match against (overrides the one in pattern)

Returns

name on match, None otherwise

caspia.meadow.name.search(names, pattern, *, type=None)

Yield all names, that matched given pattern.

caspia.meadow.name.split(name, *, strict=True) → Tuple[Optional[str], str]

Split name to its type and path.

Parameters

• name – the name to split

• strict – raise ValueError if type not specified. If False, returns None for unspecified type.

Returns

tuple (type, path)

caspia.meadow.name.update(name, **kwargs) → str

Update some part of name with something else.

Parameters

• name – the input name

• path – new path (optional)

• type – new type (optional)

caspia.meadow.namespace module

caspia.meadow.namespace.common_prefix(a, b)

caspia.meadow.namespace.join(*args)

caspia.meadow.namespace.resolve_relative(path, namespace)

caspia.meadow.namespace.split(path)

caspia.meadow.observers module

class caspia.meadow.observers.CharacteristicObserver(characteristic, value=None)

Bases: caspia.reactive.observers.Observer, caspia.meadow.serialization.Serializable, caspia.meadow.serialization.Deserializable

static create(*args, **kwargs)

static creator(*args, **kwargs)

creators = [<function CharacteristicObserver.creator>, <function FunctionObserver.creator>]

classmethod deserialize(data, context)

disable()

enable()

property is_enabled

async on_error(error, **kwargs)

async on_next(value, **kwargs)

static register_creator(creator)

serialize()

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

serialized_type = 'characteristic-write'

class caspia.meadow.observers.FunctionObserver

Bases: caspia.reactive.observers.Observer

static create(*args, **kwargs)

static creator(*args, **kwargs)

creators = [<function CharacteristicObserver.creator>, <function FunctionObserver.creator>]

disable()

enable()

property is_enabled

async on_error(error, **kwargs)

async on_next(value, **kwargs)

static register_creator(creator)

subscribe_error(on_error)

subscribe_next(on_next)

caspia.meadow.serialization module

class caspia.meadow.serialization.Deserializable

Bases: object

classmethod deserialize(data, context)

serialized_type = None

class caspia.meadow.serialization.Serializable

Bases: object

serialize()

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

caspia.meadow.utils module

async caspia.meadow.utils.acall(target, *args, **kwargs)

caspia.meadow.utils.all_subclasses(cls)

class caspia.meadow.utils.classproperty(func)

Bases: object

caspia.meadow.utils.is_future(target)

Module contents