myrtio

README

MyrtIO Go library

Library for MyrtIO protocol support in Golang.

Allows you to format and parse messages, as well as use ready-made transports.

Transports

• Serial
• UDP — not ready yet

Usage

func main() {
    port, err := serial.New(serialPath, serialBaudRate)
	if err != nil {
		log.Panic(err)
	}
    // Send ping
    response, err := m.port.RunAction(&myrtio.Message{
		Feature: 0,
		Action:  0,
	})
	if err != nil {
		log.Printf("Error: %v\n", err.Error())
	}
	defer port.Close()
}

Documentation

Index

• Constants
• Variables
• type Message
  • func ParseMessage(message []byte) (*Message, error)
  • func (m *Message) Bytes() []byte
• type Transport

Constants

const (
	FirstHeaderCode  byte = 0xFE
	SecondHeaderCode byte = 0xEF
	TailCode         byte = 0xAF
	SuccessCode      byte = 0xEE
	ErrorCode        byte = 0xFF
)

const MaxMessageLength = 128

const MetaHeaderPadding = 3

const MinMessageLength = 6

header (2) + length + feature + action + tail

Variables

var ErrWrongHeader = errors.New("unexpected header codes")

var ErrWrongLength = errors.New("message length is not correct")

var ErrWrongTail = errors.New("unexpected tail code")

Types

type Message

type Message struct {
	Feature byte
	Action  byte
	Payload []byte
}

func ParseMessage

func ParseMessage(message []byte) (*Message, error)

func (*Message) Bytes

func (m *Message) Bytes() []byte

type Transport

type Transport interface {
	RunAction(message *Message) (*Message, error)
	Close() error
}