receiver

Documentation

Overview

Package receiver is responsible for getting and handling the bytes from the communication port. Currently only serial port is supported. It is activated by the trice package and call emit.Trice() on received bytes chunks.

Index

• Variables
• func DoSerial() error
• func GetSerialPorts() ([]string, error)
• type HTTPReceiver
  • func (self *HTTPReceiver) CleanUp()
  • func (p *HTTPReceiver) GetBufferChannel() *chan []byte
  • func (p *HTTPReceiver) GetTriceChannel() *chan []byte
  • func (self *HTTPReceiver) SetUp() bool
  • func (self *HTTPReceiver) Start()
  • func (self *HTTPReceiver) Stop()
• type SerialReceiver
  • func NewSerialReceiver(portIdentifier string, baudrate int) *SerialReceiver
  • func (p *SerialReceiver) CleanUp()
  • func (p *SerialReceiver) ClosePort()
  • func (p *SerialReceiver) GetBufferChannel() *chan []byte
  • func (p *SerialReceiver) GetTriceChannel() *chan []byte
  • func (p *SerialReceiver) SetBaudrate(baudrate int)
  • func (p *SerialReceiver) SetDataBits(databits int)
  • func (p *SerialReceiver) SetParity(parity serial.Parity)
  • func (p *SerialReceiver) SetReadTimeOut(timeout int)
  • func (p *SerialReceiver) SetStopBits(stopbits serial.StopBits)
  • func (p *SerialReceiver) SetUp() bool
  • func (p *SerialReceiver) Start()
  • func (p *SerialReceiver) Stop()

Variables

var (
	// Port is the COMport name like COM1
	Port string

	// Baud is the configured baudrate of the serial port
	Baud int
)

var Cipher *xtea.Cipher

Cipher is a pointer to the cryptpo struct filled during initialization

var Crypto bool

Crypto set to true if a -key other than "none" was given

Functions

func DoSerial

func DoSerial() error

DoSerial is the endless loop for trice logging

func GetSerialPorts

func GetSerialPorts() ([]string, error)

GetSerialPorts scans for serial ports

Types

type HTTPReceiver

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

func (*HTTPReceiver) CleanUp

func (self *HTTPReceiver) CleanUp()

CleanUp washes...

func (*HTTPReceiver) GetBufferChannel

func (p *HTTPReceiver) GetBufferChannel() *chan []byte

func (*HTTPReceiver) GetTriceChannel

func (p *HTTPReceiver) GetTriceChannel() *chan []byte

func (*HTTPReceiver) SetUp

func (self *HTTPReceiver) SetUp() bool

SetUp opens...

func (*HTTPReceiver) Start

func (self *HTTPReceiver) Start()

Start starts receiving of serial data

func (*HTTPReceiver) Stop

func (self *HTTPReceiver) Stop()

Stop stops receiving of serial data

type SerialReceiver

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

func NewSerialReceiver

func NewSerialReceiver(portIdentifier string, baudrate int) *SerialReceiver

NewSerialReceiver

func (*SerialReceiver) CleanUp

func (p *SerialReceiver) CleanUp()

CleanUp makes clean

func (*SerialReceiver) ClosePort

func (p *SerialReceiver) ClosePort()

ClosePort releases port

func (*SerialReceiver) GetBufferChannel

func (p *SerialReceiver) GetBufferChannel() *chan []byte

func (*SerialReceiver) GetTriceChannel

func (p *SerialReceiver) GetTriceChannel() *chan []byte

func (*SerialReceiver) SetBaudrate

func (p *SerialReceiver) SetBaudrate(baudrate int)

SetBaudrate sets speed

func (*SerialReceiver) SetDataBits

func (p *SerialReceiver) SetDataBits(databits int)

SetDataBits sets bit count

func (*SerialReceiver) SetParity

func (p *SerialReceiver) SetParity(parity serial.Parity)

SetParity sets transmit parity

func (*SerialReceiver) SetReadTimeOut

func (p *SerialReceiver) SetReadTimeOut(timeout int)

SetReadTimeOut sets timeout

func (*SerialReceiver) SetStopBits

func (p *SerialReceiver) SetStopBits(stopbits serial.StopBits)

SetStopBits sets stop condition

func (*SerialReceiver) SetUp

func (p *SerialReceiver) SetUp() bool

SetUp opens a serial port

func (*SerialReceiver) Start

func (p *SerialReceiver) Start()

Start starts receiving of serial data

func (*SerialReceiver) Stop

func (p *SerialReceiver) Stop()

Stop stops receiving of serial data