xmodem

README

xmodem-go

support feature:

• XModem
• YModem
• CRC checksum for all
• 1k block support for all
• double CAN to break transport
• g-option for YModem

An example in folder example.

Documentation

Index

• Constants
• Variables
• type File
• type Modem
  • func NewModem(config ModemConfig, reader io.Reader, writer io.Writer) (*Modem, io.Reader, io.Writer)
  • func (m *Modem) Receive(fn Receiver) error
  • func (m *Modem) SendBreak() error
  • func (m *Modem) SendBytes(file io.Reader) error
  • func (m *Modem) SendList(files []File) error
• type ModemConfig
  • func XModemConfig(fn ModemFn) ModemConfig
  • func YModemConfig(fn ModemFn) ModemConfig
• type ModemFn
• type Receiver

Constants

const (
	XModem modemMode = iota
	YModem
)

const (
	ModemFn1k ModemFn = 1 << iota
	ModemFnCRC
	ModemFnCANCAN
	ModemFnBatch
	ModemFnG
	ModemXMin = 0
	ModemXMax = ModemXMin | ModemFn1k | ModemFnCRC | ModemFnCANCAN
	ModemYMin = ModemXMax | ModemFnBatch
	ModemYMax = ModemYMin | ModemFnG
)

Variables

var FileTooLong = errors.New("file too long")

var GModeWithWrong = errors.New("g mode with wrong")

var IOCan = errors.New("send/receive break")

var NAKTenTimes = errors.New("NAK*10")

var TooLongFileInfo = errors.New("too long file info")

var WrongModemType = errors.New("wrong modem type")

Types

type File

type File struct {
	Path    string
	Length  int64
	ModTime time.Time
	Mode    fs.FileMode
	Body    io.Reader
}

type Modem

type Modem struct {
	Config ModemConfig
	// contains filtered or unexported fields
}

func NewModem

func NewModem(config ModemConfig, reader io.Reader, writer io.Writer) (*Modem, io.Reader, io.Writer)

NewModem create a modem adapter over a (reader, writer), return the modem and a filtered (reader, writer).

func (*Modem) Receive

func (m *Modem) Receive(fn Receiver) error

Receive receive file/files for any config.

func (*Modem) SendBreak

func (m *Modem) SendBreak() error

func (*Modem) SendBytes

func (m *Modem) SendBytes(file io.Reader) error

SendBytes send a file.

func (*Modem) SendList

func (m *Modem) SendList(files []File) error

SendList send a list of files, only for YModem.

type ModemConfig

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

func XModemConfig

func XModemConfig(fn ModemFn) ModemConfig

func YModemConfig

func YModemConfig(fn ModemFn) ModemConfig

type ModemFn

type ModemFn uint32

type Receiver

type Receiver func(file File)