This is documentation for the IO integration. Please note that this is just documentation for the interface, different boards might have different caveats for the various procedures.
type Board = object
- Definition for the current board
type Port = object
- Definition for a port of pins
type Pin = object
- Definition of a pin
const defaultClock = 0.0-
This is the default clock of the current board
macro eachIt(pins: static[openArray[Pin]]; body: untyped): untyped- Copies the body for each pin in pins and defines it to be the current pin. Note that since this copies the body it should be used with care to not explode program size.
macro direction(port: static[Port]): untyped- Returns the direction of all pins in port. This is an integer wide enough to hold all the pins, inputs are set to 0 and outputs are set to 1.
macro direction(pin: static[Pin]): untyped- Returns the direction of the given pin, 0 for input and 1 for output. The width of the returned number is dependent on the size of the port.
macro state(port: static[Port]): untyped- Returns the state of all pins in port. This is an integer wide enough to hold all the pins. If the pin is an input then high is 1 and low is 0, if it is an input then 1 is pullup enabled and 0 is pullup disabled. If pullups can't be controlled on the board then input pins should not be considered.
macro state(pin: static[Pin]): untyped- Returns the state of the given pin. If the pin is an input then high is 1 and low is 0, if it is an input then 1 is pullup enabled and 0 is pullup disabled. If pullups can't be controlled on the board then input pins should not be considered. The width of the returned number is dependent on the size of the port.
macro output(port: static[Port]; mask = 0xFF'u8): untyped- Sets the port to be outputs, the mask are the pins on the port that will be set to an output. The width of the mask is dependent on the size of the port.
macro high(port: static[Port]; mask = 0xFF'u8): untyped- Sets the port to be high, the mask are the pins on the port that will be set to high. The width of the mask is dependent on the size of the port.
macro high(pin: static[Pin]): untyped- Sets the pin to high. This should only be used if the pin is an output.
macro low(port: static[Port]; mask = 0xFF'u8): untyped- Sets the port to be low, the mask are the pins on the port that will be set to low. The width of the mask is dependent on the size of the port.
macro low(pin: static[Pin]): untyped- Sets the pin to low. This should only be used if the pin is an output.
template normal(port: static[Port]; mask = 0xFF'u8): untyped- Disables the internal pullup resistor for the port, the mask are the pins on the port that will have the pullup disabled. Some boards might not support setting pullups. In that case this won't be defined.
template normal(pin: static[Pin]): untyped- Disables the internal pullup resistor for the pin. Some boards might not support setting pullups. In that case this won't be defined.
template pullup(port: static[Port]; mask = 0xFF'u8): untyped- Enables the internal pullup resistor for the port, the mask are the pins on the port that will have the pullup enabled. Some boards might not support setting pullups. In that case this won't be defined.
template pullup(pin: static[Pin]): untyped- Enables the internal pullup resistor for the pin. Some boards might not support setting pullups. In that case this won't be defined.
macro read(port: static[Port]): untyped- Reads all the values for the port, the width of the returned number depends on the size of the port. Pins that are not set as input should not be considered.
macro read(pin: static[Pin]): untyped- Reads the value of a pin, the width of the returned number depends on the size of the port. High is 1 and low is 0, pins that are not set as input should not be considered.
macro check(x: uint8; flags: varargs[untyped]): untyped- Returns true if any of the flags are not 0. A flag is the bit position in the number so register.check 2 would check the third bit in the number. This is typically used to check values in registers.
type Hz = distinct uint32- A unit for Hertz, used to set clock speeds of interfaces and the chip itself.
template Khz(n: untyped): untyped- Converts Khz into Hz, used as let newClock = 100.Khz