hueman Package

hueman Package

entities Module

class hueman.entities.Bridge(hostname, username, groups={}, plugins={}, presets={}, scenes={})

Bases: hueman.entities.Group

find(*names)

group(name)

Lookup a group by name, if name is None return all groups.

class hueman.entities.Controller(bridge, id, name, cstate=None, nstate=None)

Bases: object

commit()

Send any outstanding changes to the Endpoint.

preset(name, commit=False)

Load a preset state

reset()

Drop any uncommitted changes.

state

Return the current state

class hueman.entities.Group(bridge, id, name, cstate=None, nstate=None)

Bases: hueman.entities.Controller

Mostly useless currently, until we can create new Groups using the Hue API.

light(name)

Lookup a light by name, if name is None return all lights.

lights(*names)

class hueman.entities.Light(bridge, id, name, cstate=None, nstate=None)

Bases: hueman.entities.Controller

A light, a bulb... The fundamental endpoint.

groups Module

class hueman.groups.GroupController(name='')

Bases: object

Dispatches calls to its member Controllers (recursively!). Members can be Lights, Groups, Bridges or GroupControllers.

add_member(obj)

Add a single Light/Group/Bridge or GroupController to the current GroupController.

add_members(iter)

Shortcut to add_member when you want to add many, will consume any iterable.

find(*names)

Find members by name

group(*names)

Find members by name

light(*names)

Find members by name

members

Return a list of Group members.

class hueman.groups.Hueman(cfg)

Bases: hueman.groups.GroupController

Top level GroupController for managing all your Bridges and Configurations

scene(scene, commit=False)

util Module

hueman.util.cli(args=None)

Commandline Entrypoint

hueman.util.loader(cfg_file='~/.hueman.yml')

Shortcut function to furnish you with a configured Hueman.