powermate package

Submodules

powermate.pactl module

A small library for interacting with the pactl command line tool.

This library allows for a few simple interactions with linux pulseaudio, like viewing active sinks (sound outputs, usually loosely correlating with speakers) and their relative volumes, and setting volume absolutely or relatively.

Most functions take a sink argument which defaults to retrieving and using the first ‘RUNNING’ sink found. This uses a full subprocess, so users doing repeated calls are recommended to get a sink object (eg. through active_sink()) and pass that to successive calls.

The pactl tool will need to be installed for this library to work. It is commonly installed by default when PulseAudio is installed, and on many major distros.

class powermate.pactl.Sink(**kwargs)

Bases: object

A class wrapping attributes of PulseAudio sink properties.

LIST_PATTERNS = {'name': (<class 'str'>, 'Name: (.+)'), 'state': (<class 'str'>, 'State: (\\w+)'), 'volume': (<class 'int'>, 'Volume: 0: +(\\d+)%')}

inc_volume(delta=1)

Set a relative volume (can be negative).

name

set_volume(value)

Set an absolute volume (0-100).

state

volume

powermate.pactl.active_sink()

Retrieve the first running PulseAudio sink.

powermate.pactl.list_sinks()

Iterate system’s sink objects as Sinks.

powermate.pactl_powermate module

class powermate.pactl_powermate.PowerMate(path, long_threshold=1000)

Bases: powermate.powermate.PowerMateBase

rotate(rotation)

powermate.powermate module

class powermate.powermate.AsyncFileEventDispatcher(path, event_size=24)

Bases: object

add_listener(event_handler)

run()

send_event(event)

class powermate.powermate.Event(tv_sec, tv_usec, type, code, value)

Bases: object

classmethod fromraw(data)

raw()

class powermate.powermate.EventHandler

Bases: object

handle_event(event)

handle_events(source)

exception powermate.powermate.EventNotImplemented

Bases: NotImplementedError

Special exception type for non-implemented events.

class powermate.powermate.EventQueue(source, max_queue_size=5)

Bases: object

A thread-safe event queue which registers any number of listeners for an event source.

This will store a small number of items in order for a listener to read, and they are then available to iterate over. If more events than the specified maximum are in a listener’s queue, it will stop enqueueing new events. If for instance a listener takes a long break and max_queue_size is K, it will read the next K events after the sleep started (the oldest K events not read) and then continue to read new events. Any intermediate events will be dropped for that listener.

Listeners may be simply registered by iterating over the queue, or through the .iterate method for more configuration.

iterate(max_queue_size=None)

Register a listener on the queue, and retrieve an iterator for them.

send(event)

Send an event to the underlying event source.

watch()

Watch the underlying event source for events and send them to each registered queue.

class powermate.powermate.ExampleBadHandler(long_threshold=1000)

Bases: powermate.powermate.PowerMateEventHandler

rotate(rotation)

class powermate.powermate.ExamplePowerMate(path)

Bases: powermate.powermate.PowerMateBase

long_press()

push_rotate(rotation)

rotate(rotation)

short_press()

class powermate.powermate.FileEventSource(path, event_size)

Bases: object

An event source which reads and writes to a file object.

send(event)

Write an event to the source.

class powermate.powermate.LedEvent(brightness=255, speed=0, pulse_type=0, asleep=0, awake=0)

Bases: powermate.powermate.Event

classmethod max()

classmethod off()

classmethod percent(percent)

classmethod pulse()

value

class powermate.powermate.PowerMateBase(path, long_threshold=1000)

Bases: powermate.powermate.AsyncFileEventDispatcher, powermate.powermate.PowerMateEventHandler

class powermate.powermate.PowerMateEventHandler(long_threshold=1000)

Bases: powermate.powermate.EventHandler

handle_event(event)

long_press()

push_rotate(rotation)

rotate(rotation)

short_press()

Module contents