API Reference
Direct (non-cloud) interface to Powersensor devices
This package contains various abstractions for interacting with Powersensor devices on the local network.
The recommended approach is to use mDNS to discover plugs via their service “_powersensor._tcp.local”, and then instantiate a PlugApi to obtain the event stream from each plug.
A legacy abstraction is also provided via PowersensorDevices, which uses an older way of discovering plugs.
Lower-level interfaces are available in the PlugListener and PowersensorListener classed, though they are not recommended for general use.
Additionally a convience abstraction for translating some of the events into a household view is available in VirtualHousehold.
Quick overview: • PlugApi is the recommended API layer • PlugListener is the lower-level abstraction used by PlugApi • PowersensorDevices is the legacy main API layer • PowersensorListener provides a (legacy) lower-level abstraction • VirtualHousehold can be used to translate events into a household view
The ‘plugevents’ and ‘rawplug’ modules are helper utilities provided as debug aids, which get installed under the names ps-plugevents and ps-rawplug respectively. There are also the legacy ‘events’ and ‘rawfirehose’ debug aids which get installed under the names ps-events and ps-rawfirehose respectively.
- class powersensor_local.PlugApi(mac, ip, port=49476)[source]
Bases:
AsyncEventEmitterThe primary interface to access the interpreted event stream from a plug.
The plug may be relaying messages from one or more sensors, in addition to its own reports.
Acts as an AsyncEventEmitter. Events which can be registered for are documented in xlatemsg.translate_raw_message.