boot() should be public now

This commit is contained in:
Josh Goebel 2016-02-21 01:38:49 -05:00 committed by Scott Allen
parent 37cae4704b
commit 59c143af2f
1 changed files with 11 additions and 10 deletions

View File

@ -21,7 +21,7 @@
* *
* // #define ARDUBOY_10 * // #define ARDUBOY_10
* #define AB_DEVKIT * #define AB_DEVKIT
*/ */
#define ARDUBOY_10 //< compile for the production Arduboy v1.0 #define ARDUBOY_10 //< compile for the production Arduboy v1.0
// #define AB_DEVKIT //< compile for the official dev kit // #define AB_DEVKIT //< compile for the official dev kit
#endif #endif
@ -30,7 +30,7 @@
#ifdef AB_DEVKIT #ifdef AB_DEVKIT
#define DEVKIT //< for compatibilty with older sketches #define DEVKIT //< for compatibilty with older sketches
#define SAFE_MODE //< include safe mode (44 bytes) #define SAFE_MODE //< include safe mode (44 bytes)
#endif #endif
#ifdef ARDUBOY_10 #ifdef ARDUBOY_10
@ -145,7 +145,7 @@ public:
* will wake up the chip every 1ms - so even at 60 FPS a well written * will wake up the chip every 1ms - so even at 60 FPS a well written
* app should be able to sleep maybe half the time in between rendering * app should be able to sleep maybe half the time in between rendering
* it's own frames. * it's own frames.
* *
* See the Arduboy class nextFrame() for an example of how to use idle() * See the Arduboy class nextFrame() for an example of how to use idle()
* in a frame loop. * in a frame loop.
*/ */
@ -156,7 +156,7 @@ public:
/// put the display in command mode /// put the display in command mode
/** /**
* See SSD1306 documents for available commands and command sequences. * See SSD1306 documents for available commands and command sequences.
* *
* Links: * Links:
* - https://www.adafruit.com/datasheets/SSD1306.pdf * - https://www.adafruit.com/datasheets/SSD1306.pdf
* - http://www.eimodule.com/download/SSD1306-OLED-Controller.pdf * - http://www.eimodule.com/download/SSD1306-OLED-Controller.pdf
@ -170,13 +170,13 @@ public:
/** /**
* Bit mask that is returned: * Bit mask that is returned:
* *
* Hi Low * Hi Low
* DevKit 00000000 - reserved * DevKit 00000000 - reserved
* -DLU-RAB D down * -DLU-RAB D down
* U up * U up
* 1.0 00000000 L left * 1.0 00000000 L left
* URLDAB-- R right * URLDAB-- R right
* *
* Of course you shouldn't worry about bits (they may change with future * Of course you shouldn't worry about bits (they may change with future
* hardware revisions) and should instead use the button defines: * hardware revisions) and should instead use the button defines:
* LEFT_BUTTON, A_BUTTON, UP_BUTTON, etc. * LEFT_BUTTON, A_BUTTON, UP_BUTTON, etc.
@ -258,7 +258,6 @@ public:
/// set the light output of the RGB LEB /// set the light output of the RGB LEB
void setRGBled(uint8_t red, uint8_t green, uint8_t blue); void setRGBled(uint8_t red, uint8_t green, uint8_t blue);
protected:
/// boots the hardware /// boots the hardware
/** /**
* - sets input/output/pullup mode for pins * - sets input/output/pullup mode for pins
@ -269,6 +268,8 @@ protected:
*/ */
void static boot(); void static boot();
protected:
/// Safe mode /// Safe mode
/** /**
* Safe Mode is engaged by holding down both the LEFT button and UP button * Safe Mode is engaged by holding down both the LEFT button and UP button
@ -276,7 +277,7 @@ protected:
* loop and allows it to be reprogrammed even if you have uploaded a very * loop and allows it to be reprogrammed even if you have uploaded a very
* broken sketch that interferes with the normal USB triggered auto-reboot * broken sketch that interferes with the normal USB triggered auto-reboot
* functionality of the device. * functionality of the device.
* *
* This is most useful on Devkits because they lack a built-in reset * This is most useful on Devkits because they lack a built-in reset
* button. * button.
*/ */