frame

Documentation

Index

• func Encode(frame *Frame) []uint8
• func MakeDefaultTransactionIdProvider() func() uint8
• type Builder
  • func New() Builder
• type Direction
• type Frame
  • func Decode(buf []uint8) (*Frame, error)
• type FrameControl
• type FrameType

Functions

func Encode

func Encode(frame *Frame) []uint8

func MakeDefaultTransactionIdProvider

func MakeDefaultTransactionIdProvider() func() uint8

Types

type Builder

type Builder interface {
	FrameType(frameType FrameType) Builder
	ManufacturerCode(manufacturerCode uint16) Builder
	Direction(direction Direction) Builder
	DisableDefaultResponse(disableDefaultResponse bool) Builder
	CommandId(commandId uint8) Builder
	Command(command interface{}) Builder
	Build() (*Frame, error)
}

func New

func New() Builder

type Direction

type Direction uint8

const (
	DirectionClientServer Direction = 0x00
	DirectionServerClient Direction = 0x01
)

type Frame

type Frame struct {
	FrameControl              *FrameControl
	ManufacturerCode          uint16 `cond:"uint:FrameControl.ManufacturerSpecific==1"`
	TransactionSequenceNumber uint8
	CommandIdentifier         uint8
	Payload                   []uint8
}

frame usually has three bytes of header before payload (additional 2-byte *ManufacturerCode* when *ManufacturerSpecific* bit is set)

func Decode

func Decode(buf []uint8) (*Frame, error)

type FrameControl

type FrameControl struct {
	FrameType              FrameType `bits:"0b00000011" bitmask:"start"`
	ManufacturerSpecific   uint8     `bits:"0b00000100"`
	Direction              Direction `bits:"0b00001000"`
	DisableDefaultResponse uint8     `bits:"0b00010000"`
	Reserved               uint8     `bits:"0b11100000" bitmask:"end"`
}

type FrameType

type FrameType uint8

const (
	FrameTypeGlobal FrameType = 0x00
	FrameTypeLocal  FrameType = 0x01
)