caspia.toolbox.services.presence package

Subpackages

• caspia.toolbox.services.presence.sources package
  • Submodules
  • caspia.toolbox.services.presence.sources.arp module
  • Module contents

Submodules

caspia.toolbox.services.presence.presence module

class caspia.toolbox.services.presence.presence.Presence(*args, users=[], loop=None, **kwargs)

Bases: caspia.meadow.client.gateway.ServiceGatewayMixin, caspia.meadow.services.presence.PresenceBase

Initialize new service.

Parameters

• name – Name of the service (or just its path)

• include – What optional characteristics to include. Tuple of their names.

property all_observables

attach(connection)

property attached

auto_discovery = True

characteristic_cached_read(characteristic)

characteristic_cached_write(characteristic, value_and_meta)

async characteristic_read(characteristic, **kwargs)

Read value of the characteristic.

Parameters

• characteristic – The characteristic to which the value should be written.

• value – The value to be written.

• kwargs – Dictionary with extra key (dictionary with metadata) and optionally a timeout (float specifing explicit timeout for the operation).

Returns

Tuple (value, extra).

characteristic_subscribe(characteristic, on_value, on_error=None)

async characteristic_write(characteristic, value, **kwargs)

Write a value to the characteristic.

Parameters

• characteristic – The characteristic to which the value should be written.

• value – The value to be written.

• kwargs – Dictionary with extra key (dictionary with metadata) and optionally a timeout (float specifing explicit timeout for the operation).

characteristics = {'$metadata': <Characteristic <class 'caspia.meadow.services.base.ServiceMeta'>:$metadata>, 'state': <Characteristic <class 'caspia.meadow.services.base.ServiceMeta'>:state>, 'update': <Characteristic <class 'caspia.meadow.services.base.ServiceMeta'>:update>}

detach()

static get_subclass(stype, mixin=None)

load_definition(spec)

Update characteristics of this instance based on serialized specs.

Parameters

spec – Dict most likely going to be coming from meadow - from some gateway informing us about its services and their characteristics.

metadata

async notify(characteristic, value, if_changed=False, extra=None)

on(name, *args, **kwargs)

optional = {}

async published()

serialize()

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

state

type = 'presence'

update

class caspia.toolbox.services.presence.presence.PresenceObservation(user, state, source, timestamp, timeout)

Bases: object

property timedout

property timeout_timestamp

Module contents