serial

Documentation

Index

• func Open(portAddress string) (serial.Port, error)
• func SendCommandAndClose(port serial.Port, msg Command) error
• type AvailablePorts
  • func AllPorts() (AvailablePorts, error)
  • func (last *AvailablePorts) NewPort() (string, bool, error)
• type Command

Functions

func Open

func Open(portAddress string) (serial.Port, error)

Open used to open the given serial port at 9600 BaudRate

func SendCommandAndClose

func SendCommandAndClose(port serial.Port, msg Command) error

SendCommandAndClose send a command and immediately close the serial port afterwards.

Types

type AvailablePorts

type AvailablePorts map[string]bool

AvailablePorts represent all the available serial ports

func AllPorts

func AllPorts() (AvailablePorts, error)

AllPorts returns the list of alla available serial ports.

func (*AvailablePorts) NewPort

func (last *AvailablePorts) NewPort() (string, bool, error)

NewPort every 250ms checks if a new serial port is detected, for a maximum of 10 seconds. If a new serial port is detect it's added to the AvailablePorts map and returned as a string.

type Command

type Command string

Command represent a command sent through the serial port. This is used to distinguish a command that will trigger a specific function of the `commands.ino` sketch.

const (
	// RebootCommand puts the board in ESP mode.
	RebootCommand Command = "r\n\r"
	// VersionCommand gets the semver firmware version.
	VersionCommand Command = "v\n\r"
)