tsl

README

tsl-umd-go

TSL UMD 5.0 library / module for Golang projects

WIP Warning

This project is WIP. This project is not recommended to be used in its current form.

Documentation

Index

• type TSL5
  • func NewTSL5Instance(callback func(TSLPacket)) *TSL5
  • func (p *TSL5) ListenUDP(address string, port string) error
• type TSLControl
• type TSLControlData
• type TSLDisplayData
• type TSLDisplayMessage
• type TSLFlags
• type TSLPacket
  • func DecodePacket(data []byte) TSLPacket
• type TSLTallyColor

Types

type TSL5

type TSL5 struct {
	// contains filtered or unexported fields
}

Struct which implements a TSL 5.0 endpoint

func NewTSL5Instance

func NewTSL5Instance(callback func(TSLPacket)) *TSL5

func (*TSL5) ListenUDP

func (p *TSL5) ListenUDP(address string, port string) error

type TSLControl

type TSLControl struct {
	RightTally  TSLTallyColor  `json:"right-tally"`
	TextTally   TSLTallyColor  `json:"text-tally"`
	LeftTally   TSLTallyColor  `json:"left-tally"`
	Brightness  uint8          `json:"brightness"`
	DisplayData TSLDisplayData `json:"display-data"`
	ControlData TSLControlData `json:"control-data"`
}

Struct representing control data defined by TSL 5.0

type TSLControlData

type TSLControlData struct {
}

Struct for storing control data

type TSLDisplayData

type TSLDisplayData struct {
	Text string `json:"text"`
}

Struct for storing display data

type TSLDisplayMessage

type TSLDisplayMessage struct {
	Index   uint16     `json:"index"`
	Control TSLControl `json:"control"`
}

Struct representing a display message defined by TSL 5.0

type TSLFlags

type TSLFlags struct {
	Unicode    bool `json:"unicode"`
	ScreenData bool `json:"screen-data"`
}

Struct representing flags within a TSL 5.0 packet

type TSLPacket

type TSLPacket struct {
	Version  uint8               `json:"version"`
	Flags    TSLFlags            `json:"flags"`
	Screen   uint16              `json:"screen"`
	Messages []TSLDisplayMessage `json:"messages"`
}

Represents a TSL 5.0 packet stripped to useful information

func DecodePacket

func DecodePacket(data []byte) TSLPacket

type TSLTallyColor

type TSLTallyColor uint8

Constant defines for tally colors

const (
	TALLY_OFF   TSLTallyColor = 0
	TALLY_RED   TSLTallyColor = 1
	TALLY_GREEN TSLTallyColor = 2
	TALLY_AMBER TSLTallyColor = 3
)