fleg
/
Arduboy2
mirror of https://github.com/MLXXXp/Arduboy2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Arduboy2/keywords.txt

169 lines
3.3 KiB
Plaintext
Raw Normal View History

Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
#######################################
Add some previously missed keywords
2018-03-07 22:39:06 +00:00
# Syntax Coloring Map For Arduboy2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
#######################################
#######################################
# Datatypes (KEYWORD1)
#######################################
Update keywords.txt
2016-06-15 20:18:06 +00:00
Arduboy2 KEYWORD1
Arduboy2Base KEYWORD1
Add Beep classes for playing simple tones Also added a BeepDemo example sketch and modified the ArduBreakout example sketch to use the BeepPin1 class instead of Arduino tone().
2018-02-19 21:09:42 +00:00
BeepPin1 KEYWORD1
BeepPin2 KEYWORD1
Add some previously missed keywords
2018-03-07 22:39:06 +00:00
Point KEYWORD1
Rect KEYWORD1
Remove Sprites class constructor parameter The Sprites class has been given direct access to the screen buffer so it doesn't need a pointer to been given to it. Also updated README.md and keywords.txt, and made minor indent changes in the .h files.
2016-10-20 17:28:29 +00:00
Sprites KEYWORD1
Add SpritesB class as alternative to Sprites The SpritesB class has functions identical to those in Sprites. When used in place of Sprites it will usually reduce code size (at the expense of slower execution speed). Code size reduction is accomplished by factoring all draw modes into the same loop. Modifications made to the Sprites class to create this class made by @dxxb (Delio Brignoli). Creation of the SpritesB class and documentation by @MLXXXp (Scott Allen). Also, bootLogoSpritesBSelfMasked() and bootLogoSpritesBOverwrite() alternative boot logo functions added by @MLXXXp.
2018-03-14 14:24:53 +00:00
SpritesB KEYWORD1
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
#######################################
# Methods and Functions (KEYWORD2)
#######################################
allPixelsOn KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
begin KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
blank KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
boot KEYWORD2
bootLogo KEYWORD2
Add alternative boot logo functions New functions bootLogoCompressed(), bootLogoSpritesSelfMasked() and bootLogoSpritesOverwrite() can be used in place of bootLogo() to reduce code size in cases where their drawing functions are shared with the same functions used by the sketch. New function bootLogoShell() added to provide common code for the above functions. Also, the Sprites class functions, and functions used for drawing the logos, were made static.
2017-04-12 21:36:28 +00:00
bootLogoCompressed KEYWORD2
bootLogoShell KEYWORD2
Add SpritesB class as alternative to Sprites The SpritesB class has functions identical to those in Sprites. When used in place of Sprites it will usually reduce code size (at the expense of slower execution speed). Code size reduction is accomplished by factoring all draw modes into the same loop. Modifications made to the Sprites class to create this class made by @dxxb (Delio Brignoli). Creation of the SpritesB class and documentation by @MLXXXp (Scott Allen). Also, bootLogoSpritesBSelfMasked() and bootLogoSpritesBOverwrite() alternative boot logo functions added by @MLXXXp.
2018-03-14 14:24:53 +00:00
bootLogoSpritesBOverwrite KEYWORD2
bootLogoSpritesBSelfMasked KEYWORD2
Add alternative boot logo functions New functions bootLogoCompressed(), bootLogoSpritesSelfMasked() and bootLogoSpritesOverwrite() can be used in place of bootLogo() to reduce code size in cases where their drawing functions are shared with the same functions used by the sketch. New function bootLogoShell() added to provide common code for the above functions. Also, the Sprites class functions, and functions used for drawing the logos, were made static.
2017-04-12 21:36:28 +00:00
bootLogoSpritesOverwrite KEYWORD2
bootLogoSpritesSelfMasked KEYWORD2
Add bootLogoText() function Displays the boot logo using text instead of a bitmap, as an option to reduce code size.
2017-03-27 19:58:17 +00:00
bootLogoText KEYWORD2
Combine function __attribute__ statments Also delete getInput keyword and add buttonsState keyword
2016-03-03 05:11:47 +00:00
buttonsState KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
clear KEYWORD2
Remove Sprites class constructor parameter The Sprites class has been given direct access to the screen buffer so it doesn't need a pointer to been given to it. Also updated README.md and keywords.txt, and made minor indent changes in the .h files.
2016-10-20 17:28:29 +00:00
collide KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
cpuLoad KEYWORD2
Add delayShort() function Same as Arduino delay() except takes a 16 bit value. Mainly added to save some code in the library but can be used by sketches for the same purpose. Also changed a delay in bootLogoText() to match a previous change in bootLogo()
2017-04-17 21:34:58 +00:00
delayShort KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
digitalWriteRGB KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
display KEYWORD2
Add displayOff() and displayOn() functions displayOff() puts the display in low power mode. displayOn() re-initializes the display after displayOff() is used. The SPI initialization code was separated from the display initialization code to facilitate the new functions.
2017-04-17 21:01:10 +00:00
displayOff KEYWORD2
displayOn KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
drawBitmap KEYWORD2
drawChar KEYWORD2
drawCircle KEYWORD2
Add drawCompressed to keywords.txt
2016-12-13 16:54:25 +00:00
drawCompressed KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
drawFastHLine KEYWORD2
drawFastVLine KEYWORD2
drawLine KEYWORD2
drawPixel KEYWORD2
drawRect KEYWORD2
drawRoundRect KEYWORD2
drawSlowXYBitmap KEYWORD2
drawTriangle KEYWORD2
Add keywords for audio functions
2016-03-02 14:28:27 +00:00
enabled KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
everyXFrames KEYWORD2
Add the ability to eliminate the USB stack code Macro ARDUBOY_NO_USB will provide a substitute main() which will cause the compiler to leave out the USB code. The macro also adds a check for the DOWN button being pressed and, if so, will call the new exitToBootloader() function. New function exitToBootloader() will invoke the bootloader in command mode, similar to pressing reset.
2018-03-07 21:23:47 +00:00
exitToBootloader KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
fillCircle KEYWORD2
fillRect KEYWORD2
fillRoundRect KEYWORD2
fillScreen KEYWORD2
fillTriangle KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
flashlight KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
flipVertical KEYWORD2
flipHorizontal KEYWORD2
Refactor setRGBled() and add freeRGBled() - setRGBled() has been rewritten to directly control the hardware instead of using the Arduino analogWrite() function. - Added a two parameter version of setRGBled() that sets the brightness of one LED without affecting the others. - Added function freeRGBled() for freeing the PWM control of the LEDs so they can be used digitally. - Added example sketch RGBled.
2018-02-22 19:36:55 +00:00
freeRGBled KEYWORD2
Fix initRandomSeed(). Minor code and doc changes The call to generateRandomSeed() in initRandomSeed() was missing parentheses. Added keyword for generateRandomSeed. Minor code changes, and documentation changes and additions.
2018-04-23 19:44:15 +00:00
generateRandomSeed KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
getBuffer KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
getCursorX KEYWORD2
getCursorY KEYWORD2
Add some previously missed keywords
2018-03-07 22:39:06 +00:00
getPixel KEYWORD2
Add complimentary "get" for text "set" functions Added functions getTextColor(), getTextBackground(), getTextSize() and getTextWrap() to the Arduboy2 class
2017-07-31 20:57:28 +00:00
getTextBackground KEYWORD2
getTextColor KEYWORD2
getTextSize KEYWORD2
getTextWrap KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
height KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
idle KEYWORD2
initRandomSeed KEYWORD2
invert KEYWORD2
Remove Sprites class constructor parameter The Sprites class has been given direct access to the screen buffer so it doesn't need a pointer to been given to it. Also updated README.md and keywords.txt, and made minor indent changes in the .h files.
2016-10-20 17:28:29 +00:00
justPressed KEYWORD2
justReleased KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
nextFrame KEYWORD2
Add nextFrameDEV() function for checking CPU load
2017-02-06 21:03:15 +00:00
nextFrameDEV KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
notPressed KEYWORD2
Add keywords for audio functions
2016-03-02 14:28:27 +00:00
off KEYWORD2
on KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
paint8Pixels KEYWORD2
paintScreen KEYWORD2
Remove Sprites class constructor parameter The Sprites class has been given direct access to the screen buffer so it doesn't need a pointer to been given to it. Also updated README.md and keywords.txt, and made minor indent changes in the .h files.
2016-10-20 17:28:29 +00:00
pollButtons KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
pressed KEYWORD2
Add system EEPROM flag to disable the boot logo Flag SYS_FLAG_SHOW_LOGO added to EEPROM_SYS_FLAGS. The boot logo functions check the flag and bypass the logo sequence if the flag isn't set. Added functions writeShowBootLogoFlag() and readShowBootLogoFlag() for writing and reading the SYS_FLAG_SHOW_LOGO flag. Renamed example sketch SetNameAndID to SetSystemEEPROM and added the ability to set the SYS_FLAG_SHOW_LOGO flag, plus menus to reset the system and user EEPROM areas.
2018-03-19 19:51:21 +00:00
readShowBootLogoFlag KEYWORD2
Add EEPROM flag to disable RGB LED with boot logo Flag SYS_FLAG_SHOW_LOGO_LEDS added to EEPROM_SYS_FLAGS. The boot logo functions check the flag and leave the RGB LED off if the flag isn't set. Added functions writeShowBootLogoLEDsFlag() and readShowBootLogoLEDsFlag() for writing and reading the SYS_FLAG_SHOW_LOGO_LEDS flag. Example sketch SetSystemEEPROM modified to allow setting the SYS_FLAG_SHOW_LOGO_LEDS flag.
2018-04-06 16:51:52 +00:00
readShowBootLogoLEDsFlag KEYWORD2
Make showing the unit name with the logo optional - Added a flag in system EEPROM to indicate if the unit name should be displayed at the end of the boot logo sequence. Function bootLogoExtra() displays the unit name only if the flag is set. - Added functions writeShowUnitNameFlag() and readShowUnitNameFlag() to write and read the "Show Unit Name" flag in EEPROM. - Enhanced the SetNameAndID example sketch to allow setting the "Show Unit Name" flag in EEPROM.
2017-03-29 21:36:13 +00:00
readShowUnitNameFlag KEYWORD2
Add read/write EEPROM unit name and ID functions Also: - Changes to show the unit name on the boot logo screen - Added new example sketch SetNameAndID to allow setting the name and ID - Updated the LICENSE.txt file and made changes to include it in the Doxygen generated documentation
2017-02-06 18:34:46 +00:00
readUnitID KEYWORD2
readUnitName KEYWORD2
Fix flashlight() and safeMode() for boot problem - Timer 0 is disabled in flashlight() and safeMode() in case its variables overlap the bootloader "magic key" location. - Flashlight mode never exits if invoked. - Made safeMode() public for use as a smaller code size alternative to flashlight().
2017-03-24 19:53:35 +00:00
safeMode KEYWORD2
Add keywords for audio functions
2016-03-02 14:28:27 +00:00
saveOnOff KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
setCursor KEYWORD2
Refactor nextFrame() and add setFrameDuration() nextFrame() changes were in colaboration with @MrBlinky setFrameDuration() can be used as an alternative to setFrameRate()
2018-02-09 23:18:19 +00:00
setFrameDuration KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
setFrameRate KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
setRGBled KEYWORD2
setTextBackground KEYWORD2
Add complimentary "get" for text "set" functions Added functions getTextColor(), getTextBackground(), getTextSize() and getTextWrap() to the Arduboy2 class
2017-07-31 20:57:28 +00:00
setTextColor KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
setTextSize KEYWORD2
setTextWrap KEYWORD2
Direct control of ports and pins This eliminates calls to pinMode(), digitalWrite(), functions to initialize hardware, etc. New 2 parameter version of digitalWriteRGB() added, which sets an individual RGB LED on or off digitally. New function SPItransfer() added to replace Arduino SPI.transfer().
2017-03-15 18:10:19 +00:00
SPItransfer KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
systemButtons KEYWORD2
Add sound on/off toggle function
2016-12-13 16:49:29 +00:00
toggle KEYWORD2
Add function to wait for all buttons released New function waitNoButtons() replaces the code at the end of begin() that waits for all buttons to be released. This is to make it easier to add back this functionality when using boot() in place of begin().
2018-02-19 22:01:32 +00:00
waitNoButtons KEYWORD2
Update keywords.txt
2016-06-15 20:18:06 +00:00
width KEYWORD2
Add system EEPROM flag to disable the boot logo Flag SYS_FLAG_SHOW_LOGO added to EEPROM_SYS_FLAGS. The boot logo functions check the flag and bypass the logo sequence if the flag isn't set. Added functions writeShowBootLogoFlag() and readShowBootLogoFlag() for writing and reading the SYS_FLAG_SHOW_LOGO flag. Renamed example sketch SetNameAndID to SetSystemEEPROM and added the ability to set the SYS_FLAG_SHOW_LOGO flag, plus menus to reset the system and user EEPROM areas.
2018-03-19 19:51:21 +00:00
writeShowBootLogoFlag KEYWORD2
Add EEPROM flag to disable RGB LED with boot logo Flag SYS_FLAG_SHOW_LOGO_LEDS added to EEPROM_SYS_FLAGS. The boot logo functions check the flag and leave the RGB LED off if the flag isn't set. Added functions writeShowBootLogoLEDsFlag() and readShowBootLogoLEDsFlag() for writing and reading the SYS_FLAG_SHOW_LOGO_LEDS flag. Example sketch SetSystemEEPROM modified to allow setting the SYS_FLAG_SHOW_LOGO_LEDS flag.
2018-04-06 16:51:52 +00:00
writeShowBootLogoLEDsFlag KEYWORD2
Make showing the unit name with the logo optional - Added a flag in system EEPROM to indicate if the unit name should be displayed at the end of the boot logo sequence. Function bootLogoExtra() displays the unit name only if the flag is set. - Added functions writeShowUnitNameFlag() and readShowUnitNameFlag() to write and read the "Show Unit Name" flag in EEPROM. - Enhanced the SetNameAndID example sketch to allow setting the "Show Unit Name" flag in EEPROM.
2017-03-29 21:36:13 +00:00
writeShowUnitNameFlag KEYWORD2
Add read/write EEPROM unit name and ID functions Also: - Changes to show the unit name on the boot logo screen - Added new example sketch SetNameAndID to allow setting the name and ID - Updated the LICENSE.txt file and made changes to include it in the Doxygen generated documentation
2017-02-06 18:34:46 +00:00
writeUnitID KEYWORD2
writeUnitName KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
Add Beep classes for playing simple tones Also added a BeepDemo example sketch and modified the ArduBreakout example sketch to use the BeepPin1 class instead of Arduino tone().
2018-02-19 21:09:42 +00:00
# Arduboy2Beep classes
freq KEYWORD2
noTone KEYWORD2
timer KEYWORD2
tone KEYWORD2
Remove Sprites class constructor parameter The Sprites class has been given direct access to the screen buffer so it doesn't need a pointer to been given to it. Also updated README.md and keywords.txt, and made minor indent changes in the .h files.
2016-10-20 17:28:29 +00:00
# Sprites class
drawErase KEYWORD2
drawExternalMask KEYWORD2
drawOverwrite KEYWORD2
drawPlusMask KEYWORD2
drawSelfMasked KEYWORD2
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
#######################################
# Constants (LITERAL1)
#######################################
Improve embedded Doxygen documentation
2016-11-21 21:31:10 +00:00
ARDUBOY_LIB_VER LITERAL1
Add some previously missed keywords
2018-03-07 22:39:06 +00:00
ARDUBOY_UNIT_NAME_LEN LITERAL1
Refactor API code. Clarify and enhance user docs. Includes some suggestions and guidance by @Pharap API: - Rename non-API function swap() to swapInt16() - Make swapInt16(), drawCircleHelper(), fillCircleHelper() and struct BitStreamReader protected members of Arduboy2Base - Add #define ARDUBOY_UNIT_NAME_BUFFER_SIZE for the size of a buffer to hold a Unit Name - Move the position of the PROGMEM keyword for lcdBootProgram[] for consistency Documentation: - Remove absolute values referring to a Unit Name - More details relating to the use of the Unit Name - More details relating to the font and text functions - Other minor documentation changes and spelling corrections
2020-06-18 21:37:33 +00:00
ARDUBOY_UNIT_NAME_BUFFER_SIZE LITERAL1
Add some previously missed keywords
2018-03-07 22:39:06 +00:00
Improve embedded Doxygen documentation
2016-11-21 21:31:10 +00:00
EEPROM_STORAGE_SPACE_START LITERAL1
Update keywords.txt
2016-06-15 20:18:06 +00:00
HEIGHT LITERAL1
WIDTH LITERAL1
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
BLACK LITERAL1
WHITE LITERAL1
Improve embedded Doxygen documentation
2016-11-21 21:31:10 +00:00
INVERT LITERAL1
Squash commits up to Arduboy V1.1 release
2015-05-01 05:26:58 +00:00
Add clear option to display() and paintScreen() Also remove some trailing whitespace
2016-11-22 19:05:52 +00:00
CLEAR_BUFFER LITERAL1
Update keywords.txt
2016-06-15 20:18:06 +00:00
A_BUTTON LITERAL1
B_BUTTON LITERAL1
DOWN_BUTTON LITERAL1
LEFT_BUTTON LITERAL1
RIGHT_BUTTON LITERAL1
UP_BUTTON LITERAL1
PIN_SPEAKER_1 LITERAL1
PIN_SPEAKER_2 LITERAL1
BLUE_LED LITERAL1
GREEN_LED LITERAL1
RED_LED LITERAL1
RGB_OFF LITERAL1
RGB_ON LITERAL1
Add the ability to eliminate the USB stack code Macro ARDUBOY_NO_USB will provide a substitute main() which will cause the compiler to leave out the USB code. The macro also adds a check for the DOWN button being pressed and, if so, will call the new exitToBootloader() function. New function exitToBootloader() will invoke the bootloader in command mode, similar to pressing reset.
2018-03-07 21:23:47 +00:00
ARDUBOY_NO_USB LITERAL1