volux 0.9.8

High-level media/entertainment workflow automation platform

Volux

BRANCH	BUILD	COVERAGE	REQUIREMENTS	ISSUES	OPEN PRs
Master
Develop

Description

Volux is a high-level media/entertainment workflow automation platform.

Documentation

Volux uses readthedocs.io for it's documentation.

Read it here.

Getting Started

Installation

Install the latest stable build

$ pip install volux

Demo

Run the volume/light bar demo

$ volux demo bar

About volux

What does it do?

Volux operates using an Operator object and various instances of VoluxModule subclasses.

Each aspect of your media/entertainment setup is represented by it's own volux module.

The operator object acts as a hub for a standard method of communication between Volux modules added to it.

Official Modules

Module	Aspect	Controls
VoluxBar	GUI Element	display values, display colors, increase/decrease values, set values
VoluxDemoModule	CLI messages	set value, get value
VoluxDisplay	Monitor	get monitor size (wip)
VoluxLight	LIFX bulb	set color, set power, get color, get power
VoluxVolume	Computer Volume	set volume, get volume, set muted, get muted

These modules can read/write data of the associated aspects in coordiation with each other to create seamless workflows.

Installing from source

See here.

Demo script

While hovering over the bar:

Bar color	Action	Result
any	right-click	change bar color
any	double right-click	exit volux
📗 green	scroll up	🔉 increase volume
📗 green	scroll down	🔉 decrease volume
📗 green	middle-click	🔇 mute
🔴 red	scroll up	🔉 increase volume
🔴 red	scroll down	🔉 decrease volume
🔴 red	middle-click	🔇 unmute
📘 blue	scroll up	💡 increase bulb brightness
📘 blue	scroll down	💡 decrease bulb brightness
📘 blue	middle-click	💡 toggle bulb power

Features in development

• Settings GUI
• Interface customisation

Supported platforms

   Windows 7 or later

   MacOS (WIP)

   Linux (most distributions)

External Requirements

Platform	External Requirements
Darwin (MacOS)	$ brew install tcl-tk $ brew link tcl-tk --force

Issues and bugs

If you have any problems running Volux, please kindly post an issue to this repository. Issues can be solved much faster if you can provide:

• Operating system
• Desktop environment (if using Linux)
• Python version
• Summary of issues experienced
• Relevant screenshot/s (if applicable)

Additional testing has been done under these conditions:

Archi.	Operating System	Desktop Env	Python	Verison	Status	Notes
64 bit	Debian 10 Buster	Gnome 3.30.2	3.7.3	0.9.4	Working	Development conditions
64 bit	Ubuntu 16.04	N/A	3.7	0.9.4	Working	CI Conditions
64 bit	Windows 10	N/A	3.7.3	0.9.4	Working
64 bit	Windows 10	N/A	3.7.2	0.8.16	Working
64 bit	OSX 10.13.5	N/A	3.7.3	0.8.16	Broken	Ironing out the creases

Acknowledgments of work | pencil icon