machine

Documentation

Index

• Constants
• Variables
• func InitADC()
• func InitPWM()
• type ADC
  • func (adc ADC) Configure()
  • func (adc ADC) Get() uint16
• type I2C
  • func (i2c I2C) Configure(config I2CConfig)
  • func (i2c I2C) Tx(addr uint16, w, r []byte) error
• type I2CConfig
• type PWM
  • func (pwm PWM) Configure()
  • func (pwm PWM) Set(value uint16)
• type Pin
  • func (p Pin) Configure(config PinConfig)
  • func (p Pin) Get() bool
  • func (p Pin) High()
  • func (p Pin) Low()
  • func (p Pin) Set(value bool)
• type PinConfig
• type PinMode
• type RingBuffer
  • func NewRingBuffer() *RingBuffer
  • func (rb *RingBuffer) Get() (byte, bool)
  • func (rb *RingBuffer) Put(val byte) bool
  • func (rb *RingBuffer) Used() uint8
• type SPI
  • func (spi SPI) Configure(config SPIConfig)
  • func (spi SPI) Transfer(w byte) (byte, error)
• type SPIConfig
• type UART
  • func (uart UART) Buffered() int
  • func (uart UART) Configure(config UARTConfig)
  • func (uart UART) Read(data []byte) (n int, err error)
  • func (uart UART) ReadByte() (byte, error)
  • func (uart UART) Write(data []byte) (n int, err error)
  • func (uart UART) WriteByte(b byte) error
• type UARTConfig

Constants

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 (
	ErrInvalidInputPin  = errors.New("machine: invalid input pin")
	ErrInvalidOutputPin = errors.New("machine: invalid output pin")
	ErrInvalidClockPin  = errors.New("machine: invalid clock pin")
	ErrInvalidDataPin   = errors.New("machine: invalid data pin")
)

var (
	SPI0  = SPI{0}
	I2C0  = I2C{0}
	UART0 = UART{0}
)

Functions

func InitADC

func InitADC()

InitADC enables support for ADC peripherals.

func InitPWM

func InitPWM()

InitPWM enables support for PWM peripherals.

Types

type ADC

type ADC struct {
	Pin Pin
}

func (ADC) Configure

func (adc ADC) Configure()

Configure configures an ADC pin to be able to be used to read data.

func (ADC) Get

func (adc ADC) Get() uint16

Get reads the current analog value from this ADC peripheral.

type I2C

type I2C struct {
	Bus uint8
}

I2C is a generic implementation of the Inter-IC communication protocol.

func (I2C) Configure

func (i2c I2C) Configure(config I2CConfig)

Configure is intended to setup the I2C interface.

func (I2C) Tx

func (i2c I2C) Tx(addr uint16, w, r []byte) error

Tx does a single I2C transaction at the specified address.

type I2CConfig

type I2CConfig struct {
	Frequency uint32
	SCL       Pin
	SDA       Pin
}

I2CConfig is used to store config info for I2C.

type PWM

type PWM struct {
	Pin Pin
}

func (PWM) Configure

func (pwm PWM) Configure()

Configure configures a PWM pin for output.

func (PWM) Set

func (pwm PWM) Set(value uint16)

Set turns on the duty cycle for a PWM pin using the provided value.

type Pin

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) Configure

func (p Pin) Configure(config PinConfig)

func (Pin) Get

func (p Pin) Get() bool

func (Pin) High

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.

func (Pin) Low

func (p Pin) Low()

Low sets this GPIO pin to low, assuming it has been configured as an output pin. It is hardware dependent (and often undefined) what happens if you set a pin to low that is not configured as an output pin.

func (Pin) Set

func (p Pin) Set(value bool)

type PinConfig

type PinConfig struct {
	Mode PinMode
}

type PinMode

type PinMode uint8

const (
	PinInput PinMode = iota
	PinOutput
	PinInputPullup
	PinInputPulldown
)

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 NewRingBuffer

func NewRingBuffer() *RingBuffer

NewRingBuffer returns a new ring buffer.

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

type SPI struct {
	Bus uint8
}

func (SPI) Configure

func (spi SPI) Configure(config SPIConfig)

func (SPI) Transfer

func (spi SPI) Transfer(w byte) (byte, error)

Transfer writes/reads a single byte using the SPI interface.

type SPIConfig

type SPIConfig struct {
	Frequency uint32
	SCK       Pin
	MOSI      Pin
	MISO      Pin
	Mode      uint8
}

type UART

type UART struct {
	Bus uint8
}

func (UART) Buffered

func (uart UART) Buffered() int

Buffered returns the number of bytes currently stored in the RX buffer.

func (UART) Configure

func (uart UART) Configure(config UARTConfig)

Configure the UART.

func (UART) Read

func (uart UART) Read(data []byte) (n int, err error)

Read from the UART.

func (UART) ReadByte

func (uart UART) ReadByte() (byte, error)

ReadByte reads a single byte from the UART.

func (UART) Write

func (uart UART) Write(data []byte) (n int, err error)

Write to the UART.

func (UART) WriteByte

func (uart UART) WriteByte(b byte) error

WriteByte writes a single byte to the UART.

type UARTConfig

type UARTConfig struct {
	BaudRate uint32
	TX       Pin
	RX       Pin
}