Module boardmap.arduino - Occam header for Arduino specific pin mappings

Occam header for Arduino specific pin mappings.

Index

Declarations

boardmap.module:61Constant A0

VAL INT A0

Symbolic constant for accessing the first analog pin.

boardmap.module:70Constant A5

VAL INT A5

Symbolic constant for accessing the last analog pin.

Constants A1:4 do exist, they are simply not documented here for the sake of saving space.

boardmap.module:73Constant RX0

VAL INT RX0

Symbolic constant for accessing read port 0.

boardmap.module:75Constant TX0

VAL INT TX0

Symbolic constant for accessing transmit port 0.

boardmap.module:78Constant LED.PIN

VAL INT LED.PIN

Symbolic constant for on-board LED pin.

boardmap.module:94Function board.to.chip

INT INLINE FUNCTION board.to.chip (VAL INT board.pin)

Arduino specific conversion function for finding chip-specific pins from board-specific pin.

Parameters:

VAL INT board.pin The board pin to be mapped to an AVR pin.

Returns:

INT The AVR pin connected to the given board pin.

boardmap.module:107Function board.analog.to.chip

INT INLINE FUNCTION board.analog.to.chip (VAL INT board.analog.pin)

Arduino specific conversion function for finding chip-specific pins specifically for analog pins.

If the user inputs 0-5, the appropriate analog pin number is substituted. For example, if '3' is passed in as board.analog.pin, A3 is is substituted in before the lookup call.

Parameters:

VAL INT board.analog.pin The board pin to be mapped to an AVR pin.

Returns:

INT The AVR pin connected to the given board pin.

boardmap.module:130Function board.to.serial.port

INT INLINE FUNCTION board.to.serial.port (VAL INT board.pin)

Arduino specific conversion function for finding chip-specific pins specifically for serial operations.

There's really only one serial port on the Arduino, so this is a stub FUNCTION that's really just here to make sure the Arduino code complies with the API adhered to by all platform boardmap.modules.

Parameters:

VAL INT board.pin The board pin to be mapped to a serial port.

Returns:

INT The serial port corresponding to the given board pin.