eBoard
①⑧⑨
Written for SIA 2017/2018
Main Page
Pages
Tutorials
Namespaces
Classes
Files
Macros and Constants
Member
__ASSERT_USE_STDERR
[DEBUG_MODE] enables to use custom assert output
Member
__AVR_ATmega2560__
This is the Macro that will be defined automatically by the ARUDINO IDE if you compile this program for an ARDUINO MEGA 2560
Member
__AVR_ATmega328P__
This is the Macro that will be defined automatically by the ARUDINO IDE if you compile this program for an ARDUINO UNO R3
Member
_SPI_H_INCLUDED
the header macro to assure that there is a SPIClass available
Member
ANALOG_IN_10_BIT
I2CInOut
servant
Member
ANALOG_IN_8_BIT
I2CInOut
servant
Member
ANALOG_IN_MEAN_10_BIT
I2CInOut
servant
Member
ANALOG_IN_MEAN_8_BIT
I2CInOut
servant
Member
COUNTER_16_BIT
I2CInOut
servant
Member
COUNTER_8_BIT
I2CInOut
servant
Member
COUNTER_B_DIR
I2CInOut
servant
Member
COUNTER_B_DIR_PULLUP
I2CInOut
servant
Member
COUNTER_MEAN_16_BIT
I2CInOut
servant
Member
COUNTER_MEAN_8_BIT
I2CInOut
servant
Member
COUNTER_RISE_16_BIT
I2CInOut
servant
Member
COUNTER_RISE_8_BIT
I2CInOut
servant
Member
DIGITAL_IN
I2CInOut
servant
Member
DIGITAL_IN_INV
I2CInOut
servant
Member
DIGITAL_IN_PULLUP
I2CInOut
servant
Member
DIGITAL_IN_PULLUP_INV
I2CInOut
servant
Member
DIGITAL_OUT
I2CInOut
servant
Member
DIGITAL_OUT_HIGH
I2CInOut
servant
Member
DIGITAL_OUT_INV
I2CInOut
servant
Member
DIGITAL_OUT_LOW
I2CInOut
servant
Member
EBOARD_BLUETOOTH
This will appear as 0x1 in the docs but the real default value is 0x0
Member
EBOARD_BLUETOOTH_SPEED
this controls the soeed for the Bluetooth communication
Member
EBOARD_CHECK_PINS
this is a copy and paste guard to check if the pins used are still in Bound... it was designed for digital pins and shouldnt be disabled
Member
EBOARD_CHECK_PINS_PWM
this should be disabled when reaching RELEASED-state. This will check if an PWM-controlled pin is really capable of HPWM ^^
Member
EBOARD_CLAMP
set this to 0x1 to enable clamp
Member
EBOARD_DEBUG_MODE
you should definitly set EBOARD_DEBUG_MODE to 0x0 when completed developing. This will shrink the size of the program :D
Member
EBOARD_DEBUG_SPEED
this sets the speed of the Serial connection.... you probably don't need to change this
Member
EBOARD_DRIVE_ZERO
The zero speed for the main motor
Member
EBOARD_GUESSPATH
If this is set to 0x1 the library will guess the paths of included libraries based on your operating system
Member
EBOARD_HELPCAR_MAIN
Data pin of the main Motor
Member
EBOARD_HELPCAR_STEER
Data pin of the steering Motor
Member
EBOARD_I2C
This will appear as 0x1 in the docs but the real default value is 0x0
Member
EBOARD_I2C_HELPER
This will appear as 0x1 in the docs but the real default value is 0x0
Member
EBOARD_LCD
This will appear as 0x1 in the docs but the real default value is 0x0 This will enable the support for the OLED I²C 128x64 Monochrome display
Member
EBOARD_NANO
this will disable soccerBoard class
DynamixelBoard
etc!
Member
EBOARD_NEO
This will appear as 0x1 in the docs but the real default value is 0x0
Member
EBOARD_NEO_400KHZ
Defines the value to enable 400Khz communication Mode
Member
EBOARD_NEO_800KHZ
Defines the value to enable 800Khz communication Mode
Member
EBOARD_NEO_BGR
Defines the amount of needed permutation when com. in BGR-Mode
Member
EBOARD_NEO_BGRW
Defines the amount of needed permutation when com. in BGRW-Mode
Member
EBOARD_NEO_BGWR
Defines the amount of needed permutation when com. in BGWR-Mode
Member
EBOARD_NEO_BRG
Defines the amount of needed permutation when com. in BRG-Mode
Member
EBOARD_NEO_BRGW
Defines the amount of needed permutation when com. in BRGW-Mode
Member
EBOARD_NEO_BRWG
Defines the amount of needed permutation when com. in BRWG-Mode
Member
EBOARD_NEO_BWGR
Defines the amount of needed permutation when com. in BWGR-Mode
Member
EBOARD_NEO_BWRG
Defines the amount of needed permutation when com. in BWRG-Mode
Member
EBOARD_NEO_GBR
Defines the amount of needed permutation when com. in GBR-Mode
Member
EBOARD_NEO_GBRW
Defines the amount of needed permutation when com. in GBRW-Mode
Member
EBOARD_NEO_GBWR
Defines the amount of needed permutation when com. in GBWR-Mode
Member
EBOARD_NEO_GRB
Defines the amount of needed permutation when com. in GRB-Mode
Member
EBOARD_NEO_GRBW
Defines the amount of needed permutation when com. in GRBW-Mode
Member
EBOARD_NEO_GRWB
Defines the amount of needed permutation when com. in GRWB-Mode
Member
EBOARD_NEO_GWBR
Defines the amount of needed permutation when com. in GWBR-Mode
Member
EBOARD_NEO_GWRB
Defines the amount of needed permutation when com. in GWRB-Mode
Member
EBOARD_NEO_RBG
Defines the amount of needed permutation when com. in RBG-Mode
Member
EBOARD_NEO_RBGW
Defines the amount of needed permutation when com. in RBGW-Mode
Member
EBOARD_NEO_RBWG
Defines the amount of needed permutation when com. in RBWG-Mode
Member
EBOARD_NEO_RGB
Defines the amount of needed permutation when com. in RGB-Mode
Member
EBOARD_NEO_RGBW
Defines the amount of needed permutation when com. in RGBW-Mode
Member
EBOARD_NEO_RGWB
Defines the amount of needed permutation when com. in RGWB-Mode
Member
EBOARD_NEO_RWBG
Defines the amount of needed permutation when com. in RWBG-Mode
Member
EBOARD_NEO_RWGB
Defines the amount of needed permutation when com. in RWGB-Mode
Member
EBOARD_NEO_WBGR
Defines the amount of needed permutation when com. in WBGR-Mode
Member
EBOARD_NEO_WBRG
Defines the amount of needed permutation when com. in WBRG-Mode
Member
EBOARD_NEO_WGBR
Defines the amount of needed permutation when com. in WGBR-Mode
Member
EBOARD_NEO_WGRB
Defines the amount of needed permutation when com. in WGRB-Mode
Member
EBOARD_NEO_WRBG
Defines the amount of needed permutation when com. in WRBG-Mode
Member
EBOARD_NEO_WRGB
Defines the amount of needed permutation when com. in WRGB-Mode
Member
EBOARD_PWM_SPE
duty cycle for async task execution... should be higher than 1
Member
EBOARD_SHIFT_REGISTER
This will appear as 0x1 in the docs but the real default value is 0x0
Member
EBOARD_SPI_SERVO_MAX
this sets the amount of connected servos to the shield
Member
EBOARD_USE_RESET
set this to 0x0 to disable software reset
Member
EBOARD_USE_SPI
this has to be enabled to use the shield
Member
EBOARD_USE_UTILITY
this will remove multiple wrapper from compile-segment. Probably
won't
change program size
Member
EBOARD_VERSION
Defines the Version of the eBoard Header as String
Member
EBOARD_VERSION_NBR
Defines the Version of the eBoard Header as Number
Member
FREQ_HIGH
I2CInOut
servant
Member
FREQ_LOW
I2CInOut
servant
Member
HIGHSPEED
This isn't defined by default. If you define it the
LCD
will be addressed with 400kHz.
Member
LCD_COMMAND_BLACK_BACKGROUND
[internal] value to set the background of the display to black
Member
LCD_COMMAND_CHARGE_PUMP_ENABLE
[internal] value to set the PUMP to enabled
Member
LCD_COMMAND_CHARGE_PUMP_SETTING
[internal] value to enable the PUMP settings
Member
LCD_COMMAND_DISPLAY_OFF
[internal] value to disable the display
Member
LCD_COMMAND_DISPLAY_ON
[internal] value to enable the display
Member
LCD_COMMAND_MODE
[internal] value to set OLED into command mode
Member
LCD_COMMAND_SET_BRIGHTNESS
[internal] value to change the brightness of the display
Member
LCD_COMMAND_WHITE_BACKGROUND
[internal] value to set the background of the display to white
Member
LCD_DATA_MODE
[internal] value to set OLED into data mode
Member
LCD_HEIGHT
HEIGHT of all Displays
Member
LCD_HORIZONTAL_ADDRESSING
[internal] value to set the display into horizontal aaddressing mode
Member
LCD_PAGE_ADDRESSING
[internal] value to set the display into page addressing mode
Member
LCD_WIDTH
WIDTH of all displays
Member
main
This is used for copy_and_paste and renames the copied main-method
Member
PIN_BLUETOOTH_RX
this is the RX-Pin reserved for bluetooth communication
Member
PIN_BLUETOOTH_STATE
this is the STATE PIN. If it is equal to the
PIN_BLUETOOTH_RX
it won't be used!
Member
PIN_BLUETOOTH_TX
this is the TX-Pin reserved for bluetooth communication
Member
PIN_MAX
This defines the Maximum to-address pin. On MEGA its 49 on UNO its 9
Member
PIN_MOTOR_DIR
this is the DiOut pin reserved to control the dir of the main motor
Member
PIN_MOTOR_SPE
this is the DiOut FAST_PWM [~1kHz] pin reserved to control the dir of the main motor
Member
PIN_SHIFT_CLK
this is the clock pin for the SN74HC595
Member
PIN_SHIFT_DAT
this is the data pin for the SN74HC595
Member
PIN_SHIFT_LAT
this is the latch pin for the SN74HC595
Member
PREPROCESS_DEBUG
determines if there should be preprocessor output from eBoard-headerfile
Member
PWM_FAST
I2CInOut
servant
Member
PWM_SLOW
I2CInOut
servant
Member
REPT_TASK
This constant won't be defined by default :D
This enables you to make use of the async features
Member
SPI_2XCLOCK_MASK
the scaled clock mask to apply the correct devider
Member
SPI_CLOCK_DIV128
this will set the clock devider to 128
Member
SPI_CLOCK_DIV16
this will set the clock devider to 16
Member
SPI_CLOCK_DIV2
this will set the clock devider to 2
Member
SPI_CLOCK_DIV32
this will set the clock devider to 32
Member
SPI_CLOCK_DIV4
this will set the clock devider to 4
Member
SPI_CLOCK_DIV64
this will set the clock devider to 64
Member
SPI_CLOCK_DIV8
this will set the clock devider to 8
Member
SPI_CLOCK_MASK
the clock mask to apply the correct devider
Member
SPI_MODE0
this will set the mode to 0
Member
SPI_MODE1
this will set the mode to 1
Member
SPI_MODE2
this will set the mode to 2
Member
SPI_MODE3
this will set the mode to 3
Member
SPI_MODE_MASK
the mode mask to apply correct mode
Member
STOP
this will end any loop done by eBoard
[WIP-510]
EagleoutIce
22.06.2018 00:28:45