Documentation

Overview

Communicates with RS485/Modbus devices with full- or half-duplex.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/RS485_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "RS485 Bricklet"
View Source
const DeviceIdentifier = 277

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type CommunicationLEDConfig

type CommunicationLEDConfig = uint8
const (
	CommunicationLEDConfigOff               CommunicationLEDConfig = 0
	CommunicationLEDConfigOn                CommunicationLEDConfig = 1
	CommunicationLEDConfigShowHeartbeat     CommunicationLEDConfig = 2
	CommunicationLEDConfigShowCommunication CommunicationLEDConfig = 3
)

type Duplex

type Duplex = uint8
const (
	DuplexHalf Duplex = 0
	DuplexFull Duplex = 1
)

type ErrorLEDConfig

type ErrorLEDConfig = uint8
const (
	ErrorLEDConfigOff           ErrorLEDConfig = 0
	ErrorLEDConfigOn            ErrorLEDConfig = 1
	ErrorLEDConfigShowHeartbeat ErrorLEDConfig = 2
	ErrorLEDConfigShowError     ErrorLEDConfig = 3
)

type ExceptionCode

type ExceptionCode = int8
const (
	ExceptionCodeTimeout                            ExceptionCode = -1
	ExceptionCodeSuccess                            ExceptionCode = 0
	ExceptionCodeIllegalFunction                    ExceptionCode = 1
	ExceptionCodeIllegalDataAddress                 ExceptionCode = 2
	ExceptionCodeIllegalDataValue                   ExceptionCode = 3
	ExceptionCodeSlaveDeviceFailure                 ExceptionCode = 4
	ExceptionCodeAcknowledge                        ExceptionCode = 5
	ExceptionCodeSlaveDeviceBusy                    ExceptionCode = 6
	ExceptionCodeMemoryParityError                  ExceptionCode = 8
	ExceptionCodeGatewayPathUnavailable             ExceptionCode = 10
	ExceptionCodeGatewayTargetDeviceFailedToRespond ExceptionCode = 11
)

type Function

type Function = uint8
const (
	FunctionWriteLowLevel                                            Function = 1
	FunctionReadLowLevel                                             Function = 2
	FunctionEnableReadCallback                                       Function = 3
	FunctionDisableReadCallback                                      Function = 4
	FunctionIsReadCallbackEnabled                                    Function = 5
	FunctionSetRS485Configuration                                    Function = 6
	FunctionGetRS485Configuration                                    Function = 7
	FunctionSetModbusConfiguration                                   Function = 8
	FunctionGetModbusConfiguration                                   Function = 9
	FunctionSetMode                                                  Function = 10
	FunctionGetMode                                                  Function = 11
	FunctionSetCommunicationLEDConfig                                Function = 12
	FunctionGetCommunicationLEDConfig                                Function = 13
	FunctionSetErrorLEDConfig                                        Function = 14
	FunctionGetErrorLEDConfig                                        Function = 15
	FunctionSetBufferConfig                                          Function = 16
	FunctionGetBufferConfig                                          Function = 17
	FunctionGetBufferStatus                                          Function = 18
	FunctionEnableErrorCountCallback                                 Function = 19
	FunctionDisableErrorCountCallback                                Function = 20
	FunctionIsErrorCountCallbackEnabled                              Function = 21
	FunctionGetErrorCount                                            Function = 22
	FunctionGetModbusCommonErrorCount                                Function = 23
	FunctionModbusSlaveReportException                               Function = 24
	FunctionModbusSlaveAnswerReadCoilsRequestLowLevel                Function = 25
	FunctionModbusMasterReadCoils                                    Function = 26
	FunctionModbusSlaveAnswerReadHoldingRegistersRequestLowLevel     Function = 27
	FunctionModbusMasterReadHoldingRegisters                         Function = 28
	FunctionModbusSlaveAnswerWriteSingleCoilRequest                  Function = 29
	FunctionModbusMasterWriteSingleCoil                              Function = 30
	FunctionModbusSlaveAnswerWriteSingleRegisterRequest              Function = 31
	FunctionModbusMasterWriteSingleRegister                          Function = 32
	FunctionModbusSlaveAnswerWriteMultipleCoilsRequest               Function = 33
	FunctionModbusMasterWriteMultipleCoilsLowLevel                   Function = 34
	FunctionModbusSlaveAnswerWriteMultipleRegistersRequest           Function = 35
	FunctionModbusMasterWriteMultipleRegistersLowLevel               Function = 36
	FunctionModbusSlaveAnswerReadDiscreteInputsRequestLowLevel       Function = 37
	FunctionModbusMasterReadDiscreteInputs                           Function = 38
	FunctionModbusSlaveAnswerReadInputRegistersRequestLowLevel       Function = 39
	FunctionModbusMasterReadInputRegisters                           Function = 40
	FunctionSetFrameReadableCallbackConfiguration                    Function = 59
	FunctionGetFrameReadableCallbackConfiguration                    Function = 60
	FunctionGetSPITFPErrorCount                                      Function = 234
	FunctionSetBootloaderMode                                        Function = 235
	FunctionGetBootloaderMode                                        Function = 236
	FunctionSetWriteFirmwarePointer                                  Function = 237
	FunctionWriteFirmware                                            Function = 238
	FunctionSetStatusLEDConfig                                       Function = 239
	FunctionGetStatusLEDConfig                                       Function = 240
	FunctionGetChipTemperature                                       Function = 242
	FunctionReset                                                    Function = 243
	FunctionWriteUID                                                 Function = 248
	FunctionReadUID                                                  Function = 249
	FunctionGetIdentity                                              Function = 255
	FunctionCallbackReadLowLevel                                     Function = 41
	FunctionCallbackErrorCount                                       Function = 42
	FunctionCallbackModbusSlaveReadCoilsRequest                      Function = 43
	FunctionCallbackModbusMasterReadCoilsResponseLowLevel            Function = 44
	FunctionCallbackModbusSlaveReadHoldingRegistersRequest           Function = 45
	FunctionCallbackModbusMasterReadHoldingRegistersResponseLowLevel Function = 46
	FunctionCallbackModbusSlaveWriteSingleCoilRequest                Function = 47
	FunctionCallbackModbusMasterWriteSingleCoilResponse              Function = 48
	FunctionCallbackModbusSlaveWriteSingleRegisterRequest            Function = 49
	FunctionCallbackModbusMasterWriteSingleRegisterResponse          Function = 50
	FunctionCallbackModbusSlaveWriteMultipleCoilsRequestLowLevel     Function = 51
	FunctionCallbackModbusMasterWriteMultipleCoilsResponse           Function = 52
	FunctionCallbackModbusSlaveWriteMultipleRegistersRequestLowLevel Function = 53
	FunctionCallbackModbusMasterWriteMultipleRegistersResponse       Function = 54
	FunctionCallbackModbusSlaveReadDiscreteInputsRequest             Function = 55
	FunctionCallbackModbusMasterReadDiscreteInputsResponseLowLevel   Function = 56
	FunctionCallbackModbusSlaveReadInputRegistersRequest             Function = 57
	FunctionCallbackModbusMasterReadInputRegistersResponseLowLevel   Function = 58
	FunctionCallbackFrameReadable                                    Function = 61
)

type Mode

type Mode = uint8
const (
	ModeRS485           Mode = 0
	ModeModbusMasterRTU Mode = 1
	ModeModbusSlaveRTU  Mode = 2
)

type Parity

type Parity = uint8
const (
	ParityNone Parity = 0
	ParityOdd  Parity = 1
	ParityEven Parity = 2
)

type RS485Bricklet

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

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*RS485Bricklet) DeregisterErrorCountCallback

func (device *RS485Bricklet) DeregisterErrorCountCallback(registrationId uint64)

Remove a registered Error Count callback.

func (*RS485Bricklet) DeregisterFrameReadableCallback

func (device *RS485Bricklet) DeregisterFrameReadableCallback(registrationId uint64)

Remove a registered Frame Readable callback.

func (*RS485Bricklet) DeregisterModbusMasterReadCoilsResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadCoilsResponseCallback(registrationId uint64)

Remove a registered Modbus Master Read Coils Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadCoilsResponseLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadCoilsResponseLowLevelCallback(registrationId uint64)

Remove a registered Modbus Master Read Coils Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadDiscreteInputsResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadDiscreteInputsResponseCallback(registrationId uint64)

Remove a registered Modbus Master Read Discrete Inputs Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadDiscreteInputsResponseLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadDiscreteInputsResponseLowLevelCallback(registrationId uint64)

Remove a registered Modbus Master Read Discrete Inputs Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadHoldingRegistersResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadHoldingRegistersResponseCallback(registrationId uint64)

Remove a registered Modbus Master Read Holding Registers Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadHoldingRegistersResponseLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadHoldingRegistersResponseLowLevelCallback(registrationId uint64)

Remove a registered Modbus Master Read Holding Registers Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadInputRegistersResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadInputRegistersResponseCallback(registrationId uint64)

Remove a registered Modbus Master Read Input Registers Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterReadInputRegistersResponseLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusMasterReadInputRegistersResponseLowLevelCallback(registrationId uint64)

Remove a registered Modbus Master Read Input Registers Response Low Level callback.

func (*RS485Bricklet) DeregisterModbusMasterWriteMultipleCoilsResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterWriteMultipleCoilsResponseCallback(registrationId uint64)

Remove a registered Modbus Master Write Multiple Coils Response callback.

func (*RS485Bricklet) DeregisterModbusMasterWriteMultipleRegistersResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterWriteMultipleRegistersResponseCallback(registrationId uint64)

Remove a registered Modbus Master Write Multiple Registers Response callback.

func (*RS485Bricklet) DeregisterModbusMasterWriteSingleCoilResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterWriteSingleCoilResponseCallback(registrationId uint64)

Remove a registered Modbus Master Write Single Coil Response callback.

func (*RS485Bricklet) DeregisterModbusMasterWriteSingleRegisterResponseCallback

func (device *RS485Bricklet) DeregisterModbusMasterWriteSingleRegisterResponseCallback(registrationId uint64)

Remove a registered Modbus Master Write Single Register Response callback.

func (*RS485Bricklet) DeregisterModbusSlaveReadCoilsRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveReadCoilsRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Read Coils Request callback.

func (*RS485Bricklet) DeregisterModbusSlaveReadDiscreteInputsRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveReadDiscreteInputsRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Read Discrete Inputs Request callback.

func (*RS485Bricklet) DeregisterModbusSlaveReadHoldingRegistersRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveReadHoldingRegistersRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Read Holding Registers Request callback.

func (*RS485Bricklet) DeregisterModbusSlaveReadInputRegistersRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveReadInputRegistersRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Read Input Registers Request callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteMultipleCoilsRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteMultipleCoilsRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Write Multiple Coils Request Low Level callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteMultipleCoilsRequestLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteMultipleCoilsRequestLowLevelCallback(registrationId uint64)

Remove a registered Modbus Slave Write Multiple Coils Request Low Level callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteMultipleRegistersRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteMultipleRegistersRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Write Multiple Registers Request Low Level callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteMultipleRegistersRequestLowLevelCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteMultipleRegistersRequestLowLevelCallback(registrationId uint64)

Remove a registered Modbus Slave Write Multiple Registers Request Low Level callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteSingleCoilRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteSingleCoilRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Write Single Coil Request callback.

func (*RS485Bricklet) DeregisterModbusSlaveWriteSingleRegisterRequestCallback

func (device *RS485Bricklet) DeregisterModbusSlaveWriteSingleRegisterRequestCallback(registrationId uint64)

Remove a registered Modbus Slave Write Single Register Request callback.

func (*RS485Bricklet) DeregisterReadCallback

func (device *RS485Bricklet) DeregisterReadCallback(registrationId uint64)

Remove a registered Read Low Level callback.

func (*RS485Bricklet) DeregisterReadLowLevelCallback

func (device *RS485Bricklet) DeregisterReadLowLevelCallback(registrationId uint64)

Remove a registered Read Low Level callback.

func (*RS485Bricklet) DisableErrorCountCallback

func (device *RS485Bricklet) DisableErrorCountCallback() (err error)

Disables the RegisterErrorCountCallback callback.

By default the callback is disabled.

func (*RS485Bricklet) DisableReadCallback

func (device *RS485Bricklet) DisableReadCallback() (err error)

Disables the RegisterReadCallback callback.

By default the callback is disabled.

func (*RS485Bricklet) EnableErrorCountCallback

func (device *RS485Bricklet) EnableErrorCountCallback() (err error)

Enables the RegisterErrorCountCallback callback.

By default the callback is disabled.

func (*RS485Bricklet) EnableReadCallback

func (device *RS485Bricklet) EnableReadCallback() (err error)

Enables the RegisterReadCallback callback. This will disable the RegisterFrameReadableCallback callback.

By default the callback is disabled.

func (*RS485Bricklet) GetAPIVersion

func (device *RS485Bricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*RS485Bricklet) GetBootloaderMode

func (device *RS485Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*RS485Bricklet) GetBufferConfig

func (device *RS485Bricklet) GetBufferConfig() (sendBufferSize uint16, receiveBufferSize uint16, err error)

Returns the buffer configuration as set by SetBufferConfig.

func (*RS485Bricklet) GetBufferStatus

func (device *RS485Bricklet) GetBufferStatus() (sendBufferUsed uint16, receiveBufferUsed uint16, err error)

Returns the currently used bytes for the send and received buffer.

See SetBufferConfig for buffer size configuration.

func (*RS485Bricklet) GetChipTemperature

func (device *RS485Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*RS485Bricklet) GetCommunicationLEDConfig

func (device *RS485Bricklet) GetCommunicationLEDConfig() (config CommunicationLEDConfig, err error)

Returns the configuration as set by SetCommunicationLEDConfig

Associated constants:

* CommunicationLEDConfigOff
* CommunicationLEDConfigOn
* CommunicationLEDConfigShowHeartbeat
* CommunicationLEDConfigShowCommunication

func (*RS485Bricklet) GetErrorCount

func (device *RS485Bricklet) GetErrorCount() (overrunErrorCount uint32, parityErrorCount uint32, err error)

Returns the current number of overrun and parity errors.

func (*RS485Bricklet) GetErrorLEDConfig

func (device *RS485Bricklet) GetErrorLEDConfig() (config ErrorLEDConfig, err error)

Returns the configuration as set by SetErrorLEDConfig.

Associated constants:

* ErrorLEDConfigOff
* ErrorLEDConfigOn
* ErrorLEDConfigShowHeartbeat
* ErrorLEDConfigShowError

func (*RS485Bricklet) GetFrameReadableCallbackConfiguration

func (device *RS485Bricklet) GetFrameReadableCallbackConfiguration() (frameSize uint16, err error)

Returns the callback configuration as set by SetFrameReadableCallbackConfiguration.

.. versionadded:: 2.0.5$nbsp;(Plugin)

func (*RS485Bricklet) GetIdentity

func (device *RS485Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*RS485Bricklet) GetModbusCommonErrorCount

func (device *RS485Bricklet) GetModbusCommonErrorCount() (timeoutErrorCount uint32, checksumErrorCount uint32, frameTooBigErrorCount uint32, illegalFunctionErrorCount uint32, illegalDataAddressErrorCount uint32, illegalDataValueErrorCount uint32, slaveDeviceFailureErrorCount uint32, err error)

Returns the current number of errors occurred in Modbus mode.

* Timeout Error Count: Number of timeouts occurred. * Checksum Error Count: Number of failures due to Modbus frame CRC16 checksum mismatch. * Frame Too Big Error Count: Number of times frames were rejected because they exceeded maximum Modbus frame size which is 256 bytes. * Illegal Function Error Count: Number of errors when an unimplemented or illegal function is requested. This corresponds to Modbus exception code 1. * Illegal Data Address Error Count: Number of errors due to invalid data address. This corresponds to Modbus exception code 2. * Illegal Data Value Error Count: Number of errors due to invalid data value. This corresponds to Modbus exception code 3. * Slave Device Failure Error Count: Number of errors occurred on the slave device which were unrecoverable. This corresponds to Modbus exception code 4.

func (*RS485Bricklet) GetModbusConfiguration

func (device *RS485Bricklet) GetModbusConfiguration() (slaveAddress uint8, masterRequestTimeout uint32, err error)

Returns the configuration as set by SetModbusConfiguration.

func (*RS485Bricklet) GetMode

func (device *RS485Bricklet) GetMode() (mode Mode, err error)

Returns the configuration as set by SetMode.

Associated constants:

* ModeRS485
* ModeModbusMasterRTU
* ModeModbusSlaveRTU

func (*RS485Bricklet) GetRS485Configuration

func (device *RS485Bricklet) GetRS485Configuration() (baudrate uint32, parity Parity, stopbits Stopbits, wordlength Wordlength, duplex Duplex, err error)

Returns the configuration as set by SetRS485Configuration.

Associated constants:

* ParityNone
* ParityOdd
* ParityEven
* Stopbits1
* Stopbits2
* Wordlength5
* Wordlength6
* Wordlength7
* Wordlength8
* DuplexHalf
* DuplexFull

func (*RS485Bricklet) GetResponseExpected

func (device *RS485Bricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*RS485Bricklet) GetSPITFPErrorCount

func (device *RS485Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*RS485Bricklet) GetStatusLEDConfig

func (device *RS485Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*RS485Bricklet) IsErrorCountCallbackEnabled

func (device *RS485Bricklet) IsErrorCountCallbackEnabled() (enabled bool, err error)

Returns *true* if the RegisterErrorCountCallback callback is enabled, *false* otherwise.

func (*RS485Bricklet) IsReadCallbackEnabled

func (device *RS485Bricklet) IsReadCallbackEnabled() (enabled bool, err error)

Returns *true* if the RegisterReadCallback callback is enabled, *false* otherwise.

func (*RS485Bricklet) ModbusMasterReadCoils

func (device *RS485Bricklet) ModbusMasterReadCoils(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to read coils from a slave. This function creates a Modbus function code 1 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first coil to read. For backwards compatibility reasons this parameter is called Starting Address. It is not an address, but instead a coil number in the range of 1 to 65536. * Count: Number of coils to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterReadCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterReadDiscreteInputs

func (device *RS485Bricklet) ModbusMasterReadDiscreteInputs(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to read discrete inputs from a slave. This function creates a Modbus function code 2 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first discrete input to read. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a discrete input number in the range of 1 to 65536. The prefix digit 1 (for discrete input) is implicit and must be omitted. * Count: Number of discrete inputs to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterReadDiscreteInputsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterReadHoldingRegisters

func (device *RS485Bricklet) ModbusMasterReadHoldingRegisters(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to read holding registers from a slave. This function creates a Modbus function code 3 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first holding register to read. For backwards compatibility reasons this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted. * Count: Number of holding registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterReadHoldingRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterReadInputRegisters

func (device *RS485Bricklet) ModbusMasterReadInputRegisters(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to read input registers from a slave. This function creates a Modbus function code 4 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first input register to read. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead an input register number in the range of 1 to 65536. The prefix digit 3 (for input register) is implicit and must be omitted. * Count: Number of input registers to read.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterReadInputRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteMultipleCoils

func (device *RS485Bricklet) ModbusMasterWriteMultipleCoils(slaveAddress uint8, startingAddress uint32, coils []bool) (requestID uint8, err error)

In Modbus master mode this function can be used to write multiple coils of a slave. This function creates a Modbus function code 15 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first coil to write. For backwards compatibility reasons, this parameter is called Starting Address.It is not an address, but instead a coil number in the range of 1 to 65536.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteMultipleCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteMultipleCoilsLowLevel

func (device *RS485Bricklet) ModbusMasterWriteMultipleCoilsLowLevel(slaveAddress uint8, startingAddress uint32, coilsLength uint16, coilsChunkOffset uint16, coilsChunkData [440]bool) (requestID uint8, err error)

In Modbus master mode this function can be used to write multiple coils of a slave. This function creates a Modbus function code 15 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first coil to write. For backwards compatibility reasons, this parameter is called Starting Address.It is not an address, but instead a coil number in the range of 1 to 65536.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteMultipleCoilsResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteMultipleRegisters

func (device *RS485Bricklet) ModbusMasterWriteMultipleRegisters(slaveAddress uint8, startingAddress uint32, registers []uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to write multiple registers of a slave. This function creates a Modbus function code 16 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first holding register to write. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteMultipleRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteMultipleRegistersLowLevel

func (device *RS485Bricklet) ModbusMasterWriteMultipleRegistersLowLevel(slaveAddress uint8, startingAddress uint32, registersLength uint16, registersChunkOffset uint16, registersChunkData [27]uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to write multiple registers of a slave. This function creates a Modbus function code 16 request.

* Slave Address: Address of the target Modbus slave. * Starting Address: Number of the first holding register to write. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteMultipleRegistersResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteSingleCoil

func (device *RS485Bricklet) ModbusMasterWriteSingleCoil(slaveAddress uint8, coilAddress uint32, coilValue bool) (requestID uint8, err error)

In Modbus master mode this function can be used to write a single coil of a slave. This function creates a Modbus function code 5 request.

* Slave Address: Address of the target Modbus slave. * Coil Address: Number of the coil to be written. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a coil number in the range of 1 to 65536. * Coil Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteSingleCoilResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusMasterWriteSingleRegister

func (device *RS485Bricklet) ModbusMasterWriteSingleRegister(slaveAddress uint8, registerAddress uint32, registerValue uint16) (requestID uint8, err error)

In Modbus master mode this function can be used to write a single holding register of a slave. This function creates a Modbus function code 6 request.

* Slave Address: Address of the target Modbus slave. * Register Address: Number of the holding register to be written. For backwards compatibility reasons, this parameter is called Starting Address. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is implicit and must be omitted. * Register Value: Value to be written.

Upon success the function will return a non-zero request ID which will represent the current request initiated by the Modbus master. In case of failure the returned request ID will be 0.

When successful this function will also invoke the RegisterModbusMasterWriteSingleRegisterResponseCallback callback. In this callback the Request ID provided by the callback argument must be matched with the Request ID returned from this function to verify that the callback is indeed for a particular request.

func (*RS485Bricklet) ModbusSlaveAnswerReadCoilsRequest

func (device *RS485Bricklet) ModbusSlaveAnswerReadCoilsRequest(requestID uint8, coils []bool) (err error)

In Modbus slave mode this function can be used to answer a master request to read coils.

* Request ID: Request ID of the corresponding request that is being answered. * Coils: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadCoilsRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadCoilsRequestLowLevel

func (device *RS485Bricklet) ModbusSlaveAnswerReadCoilsRequestLowLevel(requestID uint8, coilsLength uint16, coilsChunkOffset uint16, coilsChunkData [472]bool) (err error)

In Modbus slave mode this function can be used to answer a master request to read coils.

* Request ID: Request ID of the corresponding request that is being answered. * Coils: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadCoilsRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadDiscreteInputsRequest

func (device *RS485Bricklet) ModbusSlaveAnswerReadDiscreteInputsRequest(requestID uint8, discreteInputs []bool) (err error)

In Modbus slave mode this function can be used to answer a master request to read discrete inputs.

* Request ID: Request ID of the corresponding request that is being answered. * Discrete Inputs: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadDiscreteInputsRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadDiscreteInputsRequestLowLevel

func (device *RS485Bricklet) ModbusSlaveAnswerReadDiscreteInputsRequestLowLevel(requestID uint8, discreteInputsLength uint16, discreteInputsChunkOffset uint16, discreteInputsChunkData [472]bool) (err error)

In Modbus slave mode this function can be used to answer a master request to read discrete inputs.

* Request ID: Request ID of the corresponding request that is being answered. * Discrete Inputs: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadDiscreteInputsRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadHoldingRegistersRequest

func (device *RS485Bricklet) ModbusSlaveAnswerReadHoldingRegistersRequest(requestID uint8, holdingRegisters []uint16) (err error)

In Modbus slave mode this function can be used to answer a master request to read holding registers.

* Request ID: Request ID of the corresponding request that is being answered. * Holding Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadHoldingRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadHoldingRegistersRequestLowLevel

func (device *RS485Bricklet) ModbusSlaveAnswerReadHoldingRegistersRequestLowLevel(requestID uint8, holdingRegistersLength uint16, holdingRegistersChunkOffset uint16, holdingRegistersChunkData [29]uint16) (err error)

In Modbus slave mode this function can be used to answer a master request to read holding registers.

* Request ID: Request ID of the corresponding request that is being answered. * Holding Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadHoldingRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadInputRegistersRequest

func (device *RS485Bricklet) ModbusSlaveAnswerReadInputRegistersRequest(requestID uint8, inputRegisters []uint16) (err error)

In Modbus slave mode this function can be used to answer a master request to read input registers.

* Request ID: Request ID of the corresponding request that is being answered. * Input Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadInputRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerReadInputRegistersRequestLowLevel

func (device *RS485Bricklet) ModbusSlaveAnswerReadInputRegistersRequestLowLevel(requestID uint8, inputRegistersLength uint16, inputRegistersChunkOffset uint16, inputRegistersChunkData [29]uint16) (err error)

In Modbus slave mode this function can be used to answer a master request to read input registers.

* Request ID: Request ID of the corresponding request that is being answered. * Input Registers: Data that is to be sent to the Modbus master for the corresponding request.

This function must be called from the RegisterModbusSlaveReadInputRegistersRequestCallback callback with the Request ID as provided by the argument of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerWriteMultipleCoilsRequest

func (device *RS485Bricklet) ModbusSlaveAnswerWriteMultipleCoilsRequest(requestID uint8) (err error)

In Modbus slave mode this function can be used to answer a master request to write multiple coils.

* Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the RegisterModbusSlaveWriteMultipleCoilsRequestCallback callback with the Request ID of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerWriteMultipleRegistersRequest

func (device *RS485Bricklet) ModbusSlaveAnswerWriteMultipleRegistersRequest(requestID uint8) (err error)

In Modbus slave mode this function can be used to answer a master request to write multiple registers.

* Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the RegisterModbusSlaveWriteMultipleRegistersRequestCallback callback with the Request ID of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerWriteSingleCoilRequest

func (device *RS485Bricklet) ModbusSlaveAnswerWriteSingleCoilRequest(requestID uint8) (err error)

In Modbus slave mode this function can be used to answer a master request to write a single coil.

* Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the RegisterModbusSlaveWriteSingleCoilRequestCallback callback with the Request ID as provided by the arguments of the callback.

func (*RS485Bricklet) ModbusSlaveAnswerWriteSingleRegisterRequest

func (device *RS485Bricklet) ModbusSlaveAnswerWriteSingleRegisterRequest(requestID uint8) (err error)

In Modbus slave mode this function can be used to answer a master request to write a single register.

* Request ID: Request ID of the corresponding request that is being answered.

This function must be called from the RegisterModbusSlaveWriteSingleRegisterRequestCallback callback with the Request ID, Register Address and Register Value as provided by the arguments of the callback.

func (*RS485Bricklet) ModbusSlaveReportException

func (device *RS485Bricklet) ModbusSlaveReportException(requestID uint8, exceptionCode ExceptionCode) (err error)

In Modbus slave mode this function can be used to report a Modbus exception for a Modbus master request.

* Request ID: Request ID of the request received by the slave. * Exception Code: Modbus exception code to report to the Modbus master.

Associated constants:

* ExceptionCodeTimeout
* ExceptionCodeSuccess
* ExceptionCodeIllegalFunction
* ExceptionCodeIllegalDataAddress
* ExceptionCodeIllegalDataValue
* ExceptionCodeSlaveDeviceFailure
* ExceptionCodeAcknowledge
* ExceptionCodeSlaveDeviceBusy
* ExceptionCodeMemoryParityError
* ExceptionCodeGatewayPathUnavailable
* ExceptionCodeGatewayTargetDeviceFailedToRespond

func (*RS485Bricklet) Read

func (device *RS485Bricklet) Read(length uint16) (message []rune, err error)

Returns up to *length* characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See EnableReadCallback and RegisterReadCallback callback.

func (*RS485Bricklet) ReadLowLevel

func (device *RS485Bricklet) ReadLowLevel(length uint16) (messageLength uint16, messageChunkOffset uint16, messageChunkData [60]rune, err error)

Returns up to *length* characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See EnableReadCallback and RegisterReadCallback callback.

func (*RS485Bricklet) ReadUID

func (device *RS485Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*RS485Bricklet) RegisterErrorCountCallback

func (device *RS485Bricklet) RegisterErrorCountCallback(fn func(uint32, uint32)) uint64

This callback is called if a new error occurs. It returns the current overrun and parity error count.

func (*RS485Bricklet) RegisterFrameReadableCallback

func (device *RS485Bricklet) RegisterFrameReadableCallback(fn func(uint16)) uint64

This callback is called if at least one frame of data is readable. The frame size is configured with SetFrameReadableCallbackConfiguration. The frame count parameter is the number of frames that can be read. This callback is triggered only once until Read is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the Read function, every time the callback triggers without checking the frame count parameter.

.. versionadded:: 2.0.5$nbsp;(Plugin)

func (*RS485Bricklet) RegisterModbusMasterReadCoilsResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterReadCoilsResponseCallback(fn func(uint8, ExceptionCode, []bool)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

Note

If reconstructing the value fails, the callback is triggered with nil for coils.

func (*RS485Bricklet) RegisterModbusMasterReadCoilsResponseLowLevelCallback

func (device *RS485Bricklet) RegisterModbusMasterReadCoilsResponseLowLevelCallback(fn func(uint8, ExceptionCode, uint16, uint16, [464]bool)) uint64

See RegisterModbusMasterReadCoilsResponseCallback

func (*RS485Bricklet) RegisterModbusMasterReadDiscreteInputsResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterReadDiscreteInputsResponseCallback(fn func(uint8, ExceptionCode, []bool)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to read discrete inputs.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

Note

If reconstructing the value fails, the callback is triggered with nil for discreteInputs.

func (*RS485Bricklet) RegisterModbusMasterReadDiscreteInputsResponseLowLevelCallback

func (device *RS485Bricklet) RegisterModbusMasterReadDiscreteInputsResponseLowLevelCallback(fn func(uint8, ExceptionCode, uint16, uint16, [464]bool)) uint64

See RegisterModbusMasterReadDiscreteInputsResponseCallback

func (*RS485Bricklet) RegisterModbusMasterReadHoldingRegistersResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterReadHoldingRegistersResponseCallback(fn func(uint8, ExceptionCode, []uint16)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to read holding registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

Note

If reconstructing the value fails, the callback is triggered with nil for holdingRegisters.

func (*RS485Bricklet) RegisterModbusMasterReadHoldingRegistersResponseLowLevelCallback

func (device *RS485Bricklet) RegisterModbusMasterReadHoldingRegistersResponseLowLevelCallback(fn func(uint8, ExceptionCode, uint16, uint16, [29]uint16)) uint64

See RegisterModbusMasterReadHoldingRegistersResponseCallback

func (*RS485Bricklet) RegisterModbusMasterReadInputRegistersResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterReadInputRegistersResponseCallback(fn func(uint8, ExceptionCode, []uint16)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to read input registers.

The parameters are request ID of the request, exception code of the response and the data as received by the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

Note

If reconstructing the value fails, the callback is triggered with nil for inputRegisters.

func (*RS485Bricklet) RegisterModbusMasterReadInputRegistersResponseLowLevelCallback

func (device *RS485Bricklet) RegisterModbusMasterReadInputRegistersResponseLowLevelCallback(fn func(uint8, ExceptionCode, uint16, uint16, [29]uint16)) uint64

See RegisterModbusMasterReadInputRegistersResponseCallback

func (*RS485Bricklet) RegisterModbusMasterWriteMultipleCoilsResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterWriteMultipleCoilsResponseCallback(fn func(uint8, ExceptionCode)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to read coils.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

func (*RS485Bricklet) RegisterModbusMasterWriteMultipleRegistersResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterWriteMultipleRegistersResponseCallback(fn func(uint8, ExceptionCode)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to write multiple registers.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timedout or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

func (*RS485Bricklet) RegisterModbusMasterWriteSingleCoilResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterWriteSingleCoilResponseCallback(fn func(uint8, ExceptionCode)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single coil.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

func (*RS485Bricklet) RegisterModbusMasterWriteSingleRegisterResponseCallback

func (device *RS485Bricklet) RegisterModbusMasterWriteSingleRegisterResponseCallback(fn func(uint8, ExceptionCode)) uint64

This callback is called only in Modbus master mode when the master receives a valid response of a request to write a single register.

The parameters are request ID of the request and exception code of the response.

Any non-zero exception code indicates a problem. If the exception code is greater than 0 then the number represents a Modbus exception code. If it is less than 0 then it represents other errors. For example, -1 indicates that the request timed out or that the master did not receive any valid response of the request within the master request timeout period as set by SetModbusConfiguration.

func (*RS485Bricklet) RegisterModbusSlaveReadCoilsRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveReadCoilsRequestCallback(fn func(uint8, uint32, uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read coils. The parameters are request ID of the request, the number of the first coil to be read and the number of coils to be read as received by the request. The number of the first coil is called starting address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

To send a response of this request use ModbusSlaveAnswerReadCoilsRequest.

func (*RS485Bricklet) RegisterModbusSlaveReadDiscreteInputsRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveReadDiscreteInputsRequestCallback(fn func(uint8, uint32, uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read discrete inputs. The parameters are request ID of the request, the number of the first discrete input and the number of discrete inputs to be read as received by the request. The number of the first discrete input is called starting address for backwards compatibility reasons. It is not an address, but instead a discrete input number in the range of 1 to 65536. The prefix digit 1 (for discrete input) is omitted.

To send a response of this request use ModbusSlaveAnswerReadDiscreteInputsRequest.

func (*RS485Bricklet) RegisterModbusSlaveReadHoldingRegistersRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveReadHoldingRegistersRequestCallback(fn func(uint8, uint32, uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read holding registers. The parameters are request ID of the request, the number of the first holding register to be read and the number of holding registers to be read as received by the request. The number of the first holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

To send a response of this request use ModbusSlaveAnswerReadHoldingRegistersRequest.

func (*RS485Bricklet) RegisterModbusSlaveReadInputRegistersRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveReadInputRegistersRequestCallback(fn func(uint8, uint32, uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to read input registers. The parameters are request ID of the request, the number of the first input register and the number of input registers to be read as received by the request. The number of the first input register is called starting address for backwards compatibility reasons. It is not an address, but instead a input register number in the range of 1 to 65536. The prefix digit 3 (for input register) is omitted.

To send a response of this request use ModbusSlaveAnswerReadInputRegistersRequest.

func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleCoilsRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteMultipleCoilsRequestCallback(fn func(uint8, uint32, []bool)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple coils. The parameters are request ID of the request, the number of the first coil and the data to be written as received by the request. The number of the first coil is called starting address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

To send a response of this request use ModbusSlaveAnswerWriteMultipleCoilsRequest.

Note

If reconstructing the value fails, the callback is triggered with nil for coils.

func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleCoilsRequestLowLevelCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteMultipleCoilsRequestLowLevelCallback(fn func(uint8, uint32, uint16, uint16, [440]bool)) uint64

See RegisterModbusSlaveWriteMultipleCoilsRequestCallback

func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleRegistersRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteMultipleRegistersRequestCallback(fn func(uint8, uint32, []uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write multiple holding registers. The parameters are request ID of the request, the number of the first holding register and the data to be written as received by the request. The number of the first holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

To send a response of this request use ModbusSlaveAnswerWriteMultipleRegistersRequest.

Note

If reconstructing the value fails, the callback is triggered with nil for registers.

func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleRegistersRequestLowLevelCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteMultipleRegistersRequestLowLevelCallback(fn func(uint8, uint32, uint16, uint16, [27]uint16)) uint64

See RegisterModbusSlaveWriteMultipleRegistersRequestCallback

func (*RS485Bricklet) RegisterModbusSlaveWriteSingleCoilRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteSingleCoilRequestCallback(fn func(uint8, uint32, bool)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single coil. The parameters are request ID of the request, the number of the coil and the value of coil to be written as received by the request. The number of the coil is called coil address for backwards compatibility reasons. It is not an address, but instead a coil number in the range of 1 to 65536.

To send a response of this request use ModbusSlaveAnswerWriteSingleCoilRequest.

func (*RS485Bricklet) RegisterModbusSlaveWriteSingleRegisterRequestCallback

func (device *RS485Bricklet) RegisterModbusSlaveWriteSingleRegisterRequestCallback(fn func(uint8, uint32, uint16)) uint64

This callback is called only in Modbus slave mode when the slave receives a valid request from a Modbus master to write a single holding register. The parameters are request ID of the request, the number of the holding register and the register value to be written as received by the request. The number of the holding register is called starting address for backwards compatibility reasons. It is not an address, but instead a holding register number in the range of 1 to 65536. The prefix digit 4 (for holding register) is omitted.

To send a response of this request use ModbusSlaveAnswerWriteSingleRegisterRequest.

func (*RS485Bricklet) RegisterReadCallback

func (device *RS485Bricklet) RegisterReadCallback(fn func([]rune)) uint64

This callback is called if new data is available.

To enable this callback, use EnableReadCallback.

Note

If reconstructing the value fails, the callback is triggered with nil for message.

func (*RS485Bricklet) RegisterReadLowLevelCallback

func (device *RS485Bricklet) RegisterReadLowLevelCallback(fn func(uint16, uint16, [60]rune)) uint64

See RegisterReadCallback

func (*RS485Bricklet) Reset

func (device *RS485Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*RS485Bricklet) SetBootloaderMode

func (device *RS485Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*RS485Bricklet) SetBufferConfig

func (device *RS485Bricklet) SetBufferConfig(sendBufferSize uint16, receiveBufferSize uint16) (err error)

Sets the send and receive buffer size in byte. In sum there is 10240 byte (10KiB) buffer available and the minimum buffer size is 1024 byte (1KiB) for both.

The current buffer content is lost if this function is called.

The send buffer holds data that was given by Write and could not be written yet. The receive buffer holds data that is received through RS485 but could not yet be send to the user, either by Read or through RegisterReadCallback callback.

func (*RS485Bricklet) SetCommunicationLEDConfig

func (device *RS485Bricklet) SetCommunicationLEDConfig(config CommunicationLEDConfig) (err error)

Sets the communication LED configuration. By default the LED shows RS485 communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

Associated constants:

* CommunicationLEDConfigOff
* CommunicationLEDConfigOn
* CommunicationLEDConfigShowHeartbeat
* CommunicationLEDConfigShowCommunication

func (*RS485Bricklet) SetErrorLEDConfig

func (device *RS485Bricklet) SetErrorLEDConfig(config ErrorLEDConfig) (err error)

Sets the error LED configuration.

By default the error LED turns on if there is any error (see RegisterErrorCountCallback callback). If you call this function with the SHOW ERROR option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

Associated constants:

* ErrorLEDConfigOff
* ErrorLEDConfigOn
* ErrorLEDConfigShowHeartbeat
* ErrorLEDConfigShowError

func (*RS485Bricklet) SetFrameReadableCallbackConfiguration

func (device *RS485Bricklet) SetFrameReadableCallbackConfiguration(frameSize uint16) (err error)

Configures the RegisterFrameReadableCallback callback. The frame size is the number of bytes, that have to be readable to trigger the callback. A frame size of 0 disables the callback. A frame size greater than 0 enables the callback and disables the RegisterReadCallback callback.

By default the callback is disabled.

.. versionadded:: 2.0.5$nbsp;(Plugin)

func (*RS485Bricklet) SetModbusConfiguration

func (device *RS485Bricklet) SetModbusConfiguration(slaveAddress uint8, masterRequestTimeout uint32) (err error)

Sets the configuration for the RS485 Modbus communication. Available options:

* Slave Address: Address to be used as the Modbus slave address in Modbus slave mode. Valid Modbus slave address range is 1 to 247. * Master Request Timeout: Specifies how long the master should wait for a response from a slave when in Modbus master mode.

func (*RS485Bricklet) SetMode

func (device *RS485Bricklet) SetMode(mode Mode) (err error)

Sets the mode of the Bricklet in which it operates. Available options are

* RS485, * Modbus Master RTU and * Modbus Slave RTU.

Associated constants:

* ModeRS485
* ModeModbusMasterRTU
* ModeModbusSlaveRTU

func (*RS485Bricklet) SetRS485Configuration

func (device *RS485Bricklet) SetRS485Configuration(baudrate uint32, parity Parity, stopbits Stopbits, wordlength Wordlength, duplex Duplex) (err error)

Sets the configuration for the RS485 communication.

Associated constants:

* ParityNone
* ParityOdd
* ParityEven
* Stopbits1
* Stopbits2
* Wordlength5
* Wordlength6
* Wordlength7
* Wordlength8
* DuplexHalf
* DuplexFull

func (*RS485Bricklet) SetResponseExpected

func (device *RS485Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*RS485Bricklet) SetResponseExpectedAll

func (device *RS485Bricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*RS485Bricklet) SetStatusLEDConfig

func (device *RS485Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*RS485Bricklet) SetWriteFirmwarePointer

func (device *RS485Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*RS485Bricklet) Write

func (device *RS485Bricklet) Write(message []rune) (messageChunkWritten uint64, err error)

Writes characters to the RS485 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See SetRS485Configuration for configuration possibilities regarding baudrate, parity and so on.

func (*RS485Bricklet) WriteFirmware

func (device *RS485Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*RS485Bricklet) WriteLowLevel

func (device *RS485Bricklet) WriteLowLevel(messageLength uint16, messageChunkOffset uint16, messageChunkData [60]rune) (messageChunkWritten uint8, err error)

Writes characters to the RS485 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See SetRS485Configuration for configuration possibilities regarding baudrate, parity and so on.

func (*RS485Bricklet) WriteUID

func (device *RS485Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

type Stopbits

type Stopbits = uint8
const (
	Stopbits1 Stopbits = 1
	Stopbits2 Stopbits = 2
)

type Wordlength

type Wordlength = uint8
const (
	Wordlength5 Wordlength = 5
	Wordlength6 Wordlength = 6
	Wordlength7 Wordlength = 7
	Wordlength8 Wordlength = 8
)