serialpacket

package

v0.1.8 Latest Latest Go to latest Published: Nov 12, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/BertoldVdb/go-misc

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Bus
- func CreateProtocol(port io.ReadWriteCloser, key []byte) *Bus
type Device
type Error
- func (e Error) Error() string
type MessageType

Constants ¶

View Source

const (
	ErrorTimeout      = Error("Command Timeout")
	ErrorNack         = Error("Command rejected")
	ErrorSyncFailed   = Error("Invaild sync response")
	ErrorNotConnected = Error("Not connected")
)

View Source

const AddressDefault = 0xFF

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Bus ¶

type Bus struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func CreateProtocol ¶

func CreateProtocol(port io.ReadWriteCloser, key []byte) *Bus

func (*Bus) CloseProtocol ¶

func (s *Bus) CloseProtocol() error

func (*Bus) GetDefaultDevice ¶

func (s *Bus) GetDefaultDevice() *Device

func (*Bus) GetDevice ¶

func (s *Bus) GetDevice(address uint8) *Device

func (*Bus) ProtocolHandler ¶

func (s *Bus) ProtocolHandler() error

func (*Bus) SetUnsolicitedHandler ¶

func (s *Bus) SetUnsolicitedHandler(cb func(msgType MessageType, buf []byte))

type Device ¶

type Device struct {
	sync.Mutex

	Timeout int
	// contains filtered or unexported fields
}

func (*Device) Connect ¶

func (s *Device) Connect() ([]byte, error)

func (*Device) ConnectForce ¶

func (s *Device) ConnectForce(serial []byte) ([]byte, error)

func (*Device) Disconnect ¶

func (s *Device) Disconnect()

func (*Device) GetDeviceSerial ¶

func (s *Device) GetDeviceSerial() ([]byte, error)

func (*Device) GetSystemTime ¶

func (s *Device) GetSystemTime() (uint64, error)

func (*Device) SendCommand ¶

func (s *Device) SendCommand(cmd MessageType, payload []byte, timeout int) ([]byte, error)

func (*Device) TestComm ¶

func (s *Device) TestComm() error

type Error ¶

type Error string

func (Error) Error ¶

func (e Error) Error() string

type MessageType ¶

type MessageType byte

Source Files ¶

View all Source files

serialpacket.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL