Robotica Documentation

Release 0.1.42

Brian May

Jan 15, 2018

 Contents

1 Robotica 3
1.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 Installation 5
2.1 Stable release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 From sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Usage 7

4 Contributing 9
4.1 Types of Contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2 Get Started! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.3 Pull Request Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
4.4 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

5 Credits 13
5.1 Development Lead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.2 Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

6 History 15
6.1 0.1.42 (2018-01-14) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.2 0.1.41 (2017-10-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.3 0.1.40 (2017-10-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.4 0.1.39 (2017-10-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
6.5 0.1.38 (2017-10-21) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.6 0.1.37 (2017-10-17) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.7 0.1.36 (2017-10-17) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.8 0.1.35 (2017-10-01) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.9 0.1.34 (2017-09-30) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.10 0.1.33 (2017-09-30) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
6.11 0.1.32 (2017-09-30) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.12 0.1.31 (2017-09-29) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.13 0.1.30 (2017-09-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.14 0.1.29 (2017-09-13) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.15 0.1.28 (2017-09-09) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
6.16 0.1.27 (2017-09-08) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

i
 6.17 0.1.26 (2017-09-07) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.18 0.1.25 (2017-09-06) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.19 0.1.24 (2017-09-02) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.20 0.1.23 (2017-08-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.21 0.1.22 (2017-08-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6.22 0.1.21 (2017-08-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.23 0.1.19 (2017-08-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.24 0.1.18 (2017-08-20) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.25 0.1.17 (2017-08-19) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.26 0.1.16 (2017-08-13) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.27 0.1.15 (2017-07-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.28 0.1.14 (2017-07-22) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.29 0.1.13 (2017-07-10) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.30 0.1.12 (2017-07-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.31 0.1.11 (2017-07-04) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.32 0.1.10 (2017-07-02) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.33 0.1.9 (2017-07-02) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.34 0.1.8 (2017-06-27) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6.35 0.1.7 (2017-06-26) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.36 0.1.6 (2017-06-25) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.37 0.1.5 (2017-06-25) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.38 0.1.4 (2017-06-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.39 0.1.3 (2017-06-24) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.40 0.1.2 (2017-06-19) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.41 0.1.1 (2017-06-18) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.42 0.1.0 (2017-06-18) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

7 Indices and tables 25

ii
 Robotica Documentation, Release 0.1.42

Contents:

Contents 1
Robotica Documentation, Release 0.1.42

2 Contents
 CHAPTER 1

Robotica

Robotic maid to scare innocent children

• Free software: GNU General Public License v3
• Documentation: https://robotica.readthedocs.io.

1.1 Features

• TODO

1.2 Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

3
Robotica Documentation, Release 0.1.42

4 Chapter 1. Robotica
 CHAPTER 2

Installation

2.1 Stable release

To install Robotica, run this command in your terminal:

$ pip install robotica

This is the preferred method to install Robotica, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.

2.2 From sources

The sources for Robotica can be downloaded from the Github repo.
You can either clone the public repository:

$ git clone git://github.com/brianmay/robotica

Or download the tarball:

$ curl -OL https://github.com/brianmay/robotica/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

5
Robotica Documentation, Release 0.1.42

6 Chapter 2. Installation
 CHAPTER 3

Usage

To use Robotica in a project:

import robotica

7
Robotica Documentation, Release 0.1.42

8 Chapter 3. Usage
 CHAPTER 4

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:

4.1 Types of Contributions

4.1.1 Report Bugs

Report bugs at https://github.com/brianmay/robotica/issues.

If you are reporting a bug, please include:
• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

4.1.2 Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants
to implement it.

4.1.3 Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to
whoever wants to implement it.

9
Robotica Documentation, Release 0.1.42

4.1.4 Write Documentation

Robotica could always use more documentation, whether as part of the official Robotica docs, in docstrings, or even
on the web in blog posts, articles, and such.

4.1.5 Submit Feedback

The best way to send feedback is to file an issue at https://github.com/brianmay/robotica/issues.

If you are proposing a feature:
• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

4.2 Get Started!

Ready to contribute? Here’s how to set up robotica for local development.

1. Fork the robotica repo on GitHub.
2. Clone your fork locally:

$ git clone git@github.com:your_name_here/robotica.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up
your fork for local development:

$ mkvirtualenv robotica
$ cd robotica/
$ python setup.py develop

4. Create a branch for local development:

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other
Python versions with tox:

$ flake8 robotica tests

$ mypy --strict --ignore-missing-imports robotica
$ python setup.py test or py.test
$ tox

To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.

10 Chapter 4. Contributing
 Robotica Documentation, Release 0.1.42

4.3 Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function
with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 3.5 and 3.6. Check https://travis-ci.org/brianmay/robotica/pull_
requests and make sure that the tests pass for all supported Python versions.

4.4 Tips

To run a subset of tests:

$ py.test tests.test_robotica

4.3. Pull Request Guidelines 11

Robotica Documentation, Release 0.1.42

12 Chapter 4. Contributing
 CHAPTER 5

Credits

5.1 Development Lead

• Brian May <brian@linuxpenguins.xyz>

5.2 Contributors

None yet. Why not be the first?

13
Robotica Documentation, Release 0.1.42

14 Chapter 5. Credits
 CHAPTER 6

History

6.1 0.1.42 (2018-01-14)

6.1.1 Fixed

• Increase number of MQTT reconnect attempts.

6.2 0.1.41 (2017-10-22)

6.2.1 Fixed

• Make sure send 0 minute timer notification after timer finishes.

6.3 0.1.40 (2017-10-22)

6.3.1 Fixed

• Make sure we process timer status messages.

6.4 0.1.39 (2017-10-22)

6.4.1 Changed

• Refactor entire execution code. Because my imaginary friend said so.

15
Robotica Documentation, Release 0.1.42

6.5 0.1.38 (2017-10-21)

6.5.1 Changed

• Simplify timer messages.

6.6 0.1.37 (2017-10-17)

6.6.1 Fixed

• Fixed bug generating action for timer update.

6.7 0.1.36 (2017-10-17)

6.7.1 Fixed

• Fixed bugs associated with timer.

6.7.2 Changed

• Timer uses current action for first event.

• Ability to replace/cancel timers.
• Add timer cancel notification.

6.8 0.1.35 (2017-10-01)

6.8.1 Changed

• Add timer count down from previous event.

6.9 0.1.34 (2017-09-30)

6.9.1 Changed

• Minor tweaks to timer algorithm.

6.10 0.1.33 (2017-09-30)

6.10.1 Changed

• Don’t send MQTT timer or template messages, these are handled locally.

16 Chapter 6. History
 Robotica Documentation, Release 0.1.42

6.11 0.1.32 (2017-09-30)

6.11.1 Changed

• Don’t send MQTT message on timer=0 minutes.

• Send more data on MQTT messages.

6.12 0.1.31 (2017-09-29)

6.12.1 Added

• Added server side timer.

• Add ability to schedule template at arbitrary time.

6.12.2 Changed

• Update to latest aiolifxc.

6.13 0.1.30 (2017-09-22)

6.13.1 Added

• Abilty to turn lights on and set color.

• Pause music before annoucements and resume if required.
• Ability to play sound files.

6.14 0.1.29 (2017-09-13)

6.14.1 Added

• Add ability to run without scheduler and process incoming actions.

6.15 0.1.28 (2017-09-09)

6.15.1 Changed

• Specify the plugin for each input and output.

• Publish complete action on MQTT output.

6.11. 0.1.32 (2017-09-30) 17

Robotica Documentation, Release 0.1.42

6.16 0.1.27 (2017-09-08)

6.16.1 Fixed

• Ensure disabled lights actions are disabled.

6.17 0.1.26 (2017-09-07)

6.17.1 Changed

• Refactor locations.
• Locations now intersect or subtract from parent locations.

6.18 0.1.25 (2017-09-06)

6.18.1 Added

• Add ability to turn off lights.

6.18.2 Changed

• Renamed location setting to locations.

6.19 0.1.24 (2017-09-02)

6.19.1 Changed

• Combine log files into one.

• MQTT message to replace schedule.

6.20 0.1.23 (2017-08-26)

6.20.1 Fixed

• More bugs fixed.

6.21 0.1.22 (2017-08-26)

6.21.1 Fixed

• Various bugs fixed.

18 Chapter 6. History
 Robotica Documentation, Release 0.1.42

6.22 0.1.21 (2017-08-26)

The “I Accidentally incremented the version two times release”.

6.22.1 Fixed

• Add missing files.

6.23 0.1.19 (2017-08-26)

6.23.1 Added

• MQTT support for execute request/response.

• MQTT support for audio events.

6.23.2 Changed

• Execute one task at a time.

• Refactor input/output code.

6.24 0.1.18 (2017-08-20)

6.24.1 Added

• Support multiple audio destinations per daemon.

6.25 0.1.17 (2017-08-19)

6.25.1 Added

• Ability to specify list of tasks.

6.25.2 Changed

• Move configuration to config directory and remove “-sample” substring.

6.26 0.1.16 (2017-08-13)

6.26.1 Added

• Add new REST API to carry out actions.

• New executor config file.

6.22. 0.1.21 (2017-08-26) 19

Robotica Documentation, Release 0.1.42

6.26.2 Changed

• Lights flash at same time as audio.

6.26.3 Fixed

• Make http error handling more robost.

6.27 0.1.15 (2017-07-22)

6.27.1 Fixed

• Add aiohttp to setup.py depends.

• Fix bad disabled logic.

6.28 0.1.14 (2017-07-22)

6.28.1 Added

• New location system.

6.28.2 Fixed

• Mypy errors.

6.29 0.1.13 (2017-07-10)

6.29.1 Changed

• Update aiolifxc from 0.5.3 to 0.5.4.

• Update pytest from 3.1.2 to 3.1.3.

6.29.2 Fixed

• Flash lights red, not green.

• Update sample schedule file.
• Clear playlist before adding new songs.
• Ignore mypy cache directory.

20 Chapter 6. History
 Robotica Documentation, Release 0.1.42

6.30 0.1.12 (2017-07-04)

6.30.1 Added

• Ability for audio to run list of commands.

• Ability to schedule music.

6.31 0.1.11 (2017-07-04)

6.31.1 Changed

• Flash light flashes 2 times, not 10.

6.31.2 Fixed

• Fix get_days_for_date replaces functionality.

6.32 0.1.10 (2017-07-02)

6.32.1 Fixed

• Actually change requirements.txt to require aiolifxc version 0.5.2.

• Update setup.py to reflect this also.

6.33 0.1.9 (2017-07-02)

6.33.1 Added

• Support aiolifxc version 0.5.2.

6.33.2 Fixed

• LIFX errors.

6.34 0.1.8 (2017-06-27)

6.34.1 Added

• Declare Python 3.6 support.

• Use aiolifxc library.
• Added new config files.

6.30. 0.1.12 (2017-07-04) 21

Robotica Documentation, Release 0.1.42

• Add music support.

• Add ability to customize command line for say program.

6.35 0.1.7 (2017-06-26)

6.35.1 Added

• Enhancements to schedule processing.

• Ability to disable LIFX support.

6.36 0.1.6 (2017-06-25)

6.36.1 Added

• disabled option for schedules, to disable without deleting.

6.36.2 Fixes

• Don’t replace other schedules unless this one is active.

6.37 0.1.5 (2017-06-25)

6.37.1 Added

• Support acting on list of lights or groups.

• Sending message to all lights asynchronously.
• One schedule can override another schedule.

6.38 0.1.4 (2017-06-24)

6.38.1 Fixes

• Add missing required depends.

• Handle Device Offline errors correctly.

6.39 0.1.3 (2017-06-24)

6.39.1 Added

• Schedule config file support.

22 Chapter 6. History
 Robotica Documentation, Release 0.1.42

• Requires my fork of aiolifx.

6.40 0.1.2 (2017-06-19)

6.40.1 Fixed

• PyPI meta information.

• day_of_week value incorrect.

6.41 0.1.1 (2017-06-18)

• No changes.

6.42 0.1.0 (2017-06-18)

• First release on PyPI.

6.40. 0.1.2 (2017-06-19) 23

Robotica Documentation, Release 0.1.42

24 Chapter 6. History
 CHAPTER 7

Indices and tables

• genindex
• modindex
• search

25