Documentation
¶
Index ¶
Constants ¶
const ( TWI_FREQ_100KHZ = 100000 TWI_FREQ_400KHZ = 400000 )
TWI_FREQ is the I2C bus speed. Normally either 100 kHz, or 400 kHz for high-speed bus.
const NoPin = Pin(-1)
NoPin explicitly indicates "not a pin". Use this pin if you want to leave one of the pins in a peripheral unconfigured (if supported by the hardware).
Variables ¶
var ( SPI0 = SPI{0} I2C0 = I2C{0} UART0 = UART{0} )
var ( ErrTxSlicesRequired = errors.New("SPI Tx requires a write or read slice, or both") ErrTxInvalidSliceSize = errors.New("SPI write and read slices must be same size") )
Functions ¶
Types ¶
type ADC ¶
type ADC struct {
Pin Pin
}
type I2C ¶ added in v0.7.0
type I2C struct {
Bus uint8
}
I2C is a generic implementation of the Inter-IC communication protocol.
func (I2C) ReadRegister ¶ added in v0.7.0
ReadRegister transmits the register, restarts the connection as a read operation, and reads the response.
Many I2C-compatible devices are organized in terms of registers. This method is a shortcut to easily read such registers. Also, it only works for devices with 7-bit addresses, which is the vast majority.
func (I2C) WriteRegister ¶ added in v0.7.0
WriteRegister transmits first the register and then the data to the peripheral device.
Many I2C-compatible devices are organized in terms of registers. This method is a shortcut to easily write to such registers. Also, it only works for devices with 7-bit addresses, which is the vast majority.
type PWM ¶
type PWM struct {
Pin Pin
}
type Pin ¶ added in v0.6.0
type Pin int8
Pin is a single pin on a chip, which may be connected to other hardware devices. It can either be used directly as GPIO pin or it can be used in other peripherals like ADC, I2C, etc.
func (Pin) High ¶ added in v0.6.0
func (p Pin) High()
High sets this GPIO pin to high, assuming it has been configured as an output pin. It is hardware dependent (and often undefined) what happens if you set a pin to high that is not configured as an output pin.
type RingBuffer ¶
type RingBuffer struct {
// contains filtered or unexported fields
}
RingBuffer is ring buffer implementation inspired by post at https://www.embeddedrelated.com/showthread/comp.arch.embedded/77084-1.php
It has some limitations currently due to how "volatile" variables that are members of a struct are not compiled correctly by TinyGo. See https://github.com/tinygo-org/tinygo/issues/151 for details.
func (*RingBuffer) Get ¶
func (rb *RingBuffer) Get() (byte, bool)
Get returns a byte from the buffer. If the buffer is empty, the method will return a false as the second value.
func (*RingBuffer) Put ¶
func (rb *RingBuffer) Put(val byte) bool
Put stores a byte in the buffer. If the buffer is already full, the method will return false.
func (*RingBuffer) Used ¶
func (rb *RingBuffer) Used() uint8
Used returns how many bytes in buffer have been used.
type SPI ¶ added in v0.7.0
type SPI struct {
Bus uint8
}
func (SPI) Tx ¶ added in v0.7.0
Tx handles read/write operation for SPI interface. Since SPI is a syncronous write/read interface, there must always be the same number of bytes written as bytes read. The Tx method knows about this, and offers a few different ways of calling it.
This form sends the bytes in tx buffer, putting the resulting bytes read into the rx buffer. Note that the tx and rx buffers must be the same size:
spi.Tx(tx, rx)
This form sends the tx buffer, ignoring the result. Useful for sending "commands" that return zeros until all the bytes in the command packet have been received:
spi.Tx(tx, nil)
This form sends zeros, putting the result into the rx buffer. Good for reading a "result packet":
spi.Tx(nil, rx)
type UART ¶ added in v0.7.0
type UART struct {
Bus uint8
}
func (UART) Buffered ¶ added in v0.7.0
Buffered returns the number of bytes currently stored in the RX buffer.
func (UART) Configure ¶ added in v0.7.0
func (uart UART) Configure(config UARTConfig)
Configure the UART.
Source Files