davegoopot / rube-mc-pi

Infrastructure code needed to make the Manchester CoderDojo Rube Goldberg machine work.

rube-mc-pi

Infrastructure code needed to make the Manchester CoderDojo Rube Goldberg machine work.

For more info see: http://wiki.mcrcoderdojo.org.uk/index.php/Rube_Goldberg_Project

Coding Guidelines

• Create a feature branch for your change
• Write a test that fails
• python setup.py test
• Write code to make the test pass
• Repeat until done
• Commit changes to branch
• pylint rube-mc-pi | less
• Fix lint issues
• python setup.py test
• If tests pass commit to branch
• Merge branch to master
• python setup.py test
• If tests pass commit to branch
• If you want to release to pypi...
• Ideally on a raspberry pi run python setup.py test (this is to make sure the gpio code is tested)
• Edit setup.pi
• Change the version number following these guidelines http://apr.apache.org/versioning.html
• Commit to master
• git push origin master
• Publish with: python setup.py register sdist upload

rube-mc-pi's Issues

Chaining sources and targets together

The system needs a mechanism for registering chains of sources and targets

Minecraft Adaptor

Need a minecraft adaptor that will handle getting and setting the state of blocks.

blocks like mcpi

The block object should respond to the same API as the mcpi version -- use the mcpi version?

Scratch Adaptor

Need an adaptor that links into scratch

Make sure that the states are read the first time but don't cause a target update

Updating state is not recording the new state on the target object

Simple HTTP Adaptor

File Adaptor

Update and read state from a file

GPIO adaptor

Need an adaptor that links to GPIO pins of the Raspberry Pi

Logging

Probably will need to give sources and targets names

updateState mechanism

A target should accept an updateState mechanism taking a block object as its parameter

Add in python lint checker to testing process

Simple console adaptor

Query state

A source should respond to a getState() query by returning its state.

Event Loop

The system should loop over all sources and update the linked targets whenever the state of the source block changes.