Initial release of MagicBot framework

[virtuald]

In the spirit of "release early, release often", I'm happy to announce the first version of MagicBot, which is bundled with robotpy-wpilib-utilities 2016.3.0.

MagicBot is an opinionated framework for creating Python robot programs for the FIRST Robotics Competition. It is envisioned to eventually be an easier to use pythonic alternative to the Command framework.

This initial release tackles the following problems:


Reduced boilerplate associated with creating multiple component objects and passing them around
Providing a solid foundation for developing robot programs structured in a particular way
Automatic integration of the autonomous mode chooser


Future problem areas I intend to tackle:


Automatic NetworkTable value publishing
Generalized state machine via decorators (similar to StatefulAutonomous)


It's still lightly tested, not complete by any means, and I still have a few more ideas to add to it. However, what's there will probably work. ;)

Read more (http://robotpy-wpilib-utilities.readthedocs.org/en/latest/magicbot.html) | Simple example program (https://github.com/robotpy/robotpy-wpilib-utilities/tree/master/samples/magicbot_simple)

Feedback and bug reports welcome!

[virtuald]

Magicbot has had a lot of upgrades this season, and hopefully in the offseason I'll be able to add some more things and document them.

Two particular new features in today's release that I wanted to highlight:


There is a 'tunable' property (http://robotpy-wpilib-utilities.readthedocs.org/en/latest/magicbot.html#magicbot.magic_tunable.tunable) that you can add to automatically add variables to networktables (sorta like ntproperty, but less verbose)
Do you like the autonomous state machine builder? Of course you do! Well, you can create magicbot components using the same style of declarative state machine helpers (http://robotpy-wpilib-utilities.readthedocs.org/en/latest/magicbot.html#magicbot.state_machine.StateMachine) !


As an example, here's a theoretical shooter component:


class ShooterAutomation:

# Some other component
shooter = Shooter
ball_pusher = BallPusher

def fire(self):
"""This is called from the main loop"""
self.engage()

@state(first=True)
def begin_firing(self):
self.shooter.enable()
if self.shooter.ready():
self.next_state('firing')

@timed_state(duration=1.0, must_finish=True)
def firing(self):
"""This state will continue executing even if engage isn't called"""
self.shooter.enable()
self.ball_pusher.push()

...

class MyRobot(magicbot.MagicRobot):

...

def teleopPeriodic(self):

if self.joystick.getTrigger():
self.shooter_automation.fire()




If you're competing at the Championship, you probably won't want to upgrade. But for the rest of you, download it and give it a shot.