devices

Documentation

Index

• Constants
• type BaseResponse
• type DevCommandConfig
• type DevCommandRequest
• type DevCommandResponse
• type DevModBusRequest
• type DevModBusResponse
• type DevModBusRtuConfig
• type DevModBusTcpConfig
• type DevMqttConfig
• type DevMqttRequest
• type DevSmartBusConfig
• type DevSmartBusRequest
• type DevSmartBusResponse

Constants

const (
	DevTypeModbusRtu = DeviceType("modbus_rtu")
	DevTypeModbusTcp = DeviceType("modbus_tcp")

	// bit access
	ReadCoils          = "ReadCoils"
	ReadDiscreteInputs = "ReadDiscreteInputs"
	WriteSingleCoil    = "WriteSingleCoil"
	WriteMultipleCoils = "WriteMultipleCoils"

	// 16-bit access
	ReadInputRegisters         = "ReadInputRegisters"
	ReadHoldingRegisters       = "ReadHoldingRegisters"
	ReadWriteMultipleRegisters = "ReadWriteMultipleRegisters"
	WriteSingleRegister        = "WriteSingleRegister"
	WriteMultipleRegisters     = "WriteMultipleRegisters"
)

const (
	DevTypeCommand = DeviceType("command")
)

const (
	DevTypeDefault = DeviceType("default")
)

const (
	DevTypeMqtt = DeviceType("mqtt")
)

const (
	DevTypeSmartBus = DeviceType("smartbus")
)

Types

type BaseResponse

type BaseResponse struct {
	Error string  `json:"error"`
	Time  float64 `json:"time"`
}

type DevCommandConfig

type DevCommandConfig struct {
	Validation
}

type DevCommandRequest

type DevCommandRequest struct {
	Name string   `json:"name"`
	Args []string `json:"args"`
}

type DevCommandResponse

type DevCommandResponse struct {
	BaseResponse
	Result string `json:"result"`
}

type DevModBusRequest

type DevModBusRequest struct {
	Function string   `json:"function"`
	Address  uint16   `json:"address"`
	Count    uint16   `json:"count"`
	Command  []uint16 `json:"command"`
}

type DevModBusResponse

type DevModBusResponse struct {
	BaseResponse
	Result []uint16 `json:"result"`
}

params: result error time

type DevModBusRtuConfig

type DevModBusRtuConfig struct {
	Validation
	SlaveId  int    `json:"slave_id" mapstructure:"slave_id"`   // 1-32
	Baud     int    `json:"baud"`                               // 9600, 19200, ...
	DataBits int    `json:"data_bits" mapstructure:"data_bits"` // 5-9
	StopBits int    `json:"stop_bits" mapstructure:"stop_bits"` // 1, 2
	Parity   string `json:"parity"`                             // none, odd, even
	Timeout  int    `json:"timeout"`                            // milliseconds
}

type DevModBusTcpConfig

type DevModBusTcpConfig struct {
	Validation
	SlaveId     int    `json:"slave_id" mapstructure:"slave_id"`
	AddressPort string `json:"address_port" mapstructure:"address_port"`
}

type DevMqttConfig

type DevMqttConfig struct {
	Validation
	Address  string `json:"address"`
	User     string `json:"user"`
	Password string `json:"password"`
}

type DevMqttRequest

type DevMqttRequest struct {
	Topic   string `json:"topic"`
	Payload []byte `json:"payload"`
	Qos     uint8  `json:"qos"`
	Retain  bool   `json:"retain"`
}

type DevSmartBusConfig

type DevSmartBusConfig struct {
	Validation
	Baud     int `json:"baud" valid:"Required"`
	Device   int `json:"device"`
	Timeout  int `json:"timeout" valid:"Required"`
	StopBits int `json:"stop_bits" valid:"Required" mapstructure:"stop_bits"`
	Sleep    int `json:"sleep"`
}

type DevSmartBusRequest

type DevSmartBusRequest struct {
	Command []byte `json:"command"`
}

type DevSmartBusResponse

type DevSmartBusResponse struct {
	BaseResponse
	Result []byte `json:"result"`
}