Serial Receiver Read

Receives commands from a serial receiver such as DSMX or S.BUS. This block is intended for use in the main diagram.

Library

Description

The Serial Receiver Read block receives commands from a serial receiver over a stream. The stream is typically a serial connection. The commands for up to 16 channels are extracted from the incoming frames and output from the block, along with any extra information contained in the data. A vector is also output indicating which channel data is new, as some protocols do not send all the channel data in one frame.

This block does not wait for data to arrive. It is non-blocking since frames are received over the stream in a background thread. The most recent commands are output from the block.

The Serial Receiver Read block maintains a persistent connection with the stream, so it will reconnect automatically if the connection is lost. The current state of the connection is also output from the block.

If an error occurs, then the block returns a negative error code at its err output. The Compare to Error block may be used to check for specific error codes.

Configuration Requirements

DSM serial configuration

The serial stream for DSMX or DSM2 is typically configured for 115200 baud, one stop bit, no parity and no flow control. The URI to use is:

serial://localhost:0?baud='115200',parity='none',stop='1',flow='none'.

Note that the port number in the URI must be changed to match the UART used to receive the DSMX or DSM2 signals.

S.BUS serial configuration

The serial stream for S.BUS must be configured for 100000 baud, two stop bits, even parity and no flow control. The URI to use is:

serial://localhost:0?baud='100000',parity='even',stop='2',flow='none'.

Note that the port number in the URI must be changed to match the UART used to receive the S.BUS signals.

S.BUS signal inversion

S.BUS signals are generally inverted from the signals produced by a standard UART, so an inverter may be required on the S.BUS signal prior to the UART. For serial ports which support polarity inversion, the polarity=on option can be added to the URI to do the polarity inversion so that an external logic inverter is not required. For example:

serial://localhost:0?baud='100000',parity='even',stop='2',flow='none',polarity='on'

Input Ports

This block has no input ports.

Output Ports

state

The current status of the connection. The possible states are tabulated below:

err

If an error occurs receiving the data, then this output is a negative QUARC error code indicating the cause of the problem. Otherwise it is zero. It is a 32-bit signed integer.

int

A double scalar indicating the time interval between frames, in seconds. This value is useful for determining if a serial receiver is operating as expected.

ch

This output depends on the Map minimum to, Map maximum to and Output data type parameters. This output is always a 16 element vector where each element corresponds to a separate RC channel. However the data type and range changes depending on aforementioned parameters. Refer to the parameters for more details.

new

A 16-element vector indicating whether the values presented at the ch output port represent newly received data from the peer. If an element is false (zero) then no data for the corresponding channel has been received from the peer in this sampling instant.

This output is a vector because protocols like DSMX or DSM2 require more than one frame to be sent to provide 16 channels worth of data. Hence, not all channels will necessarily have new data each sampling instant.

fade

The number of missed frames for the DSM protocols, as a uint16.

sys

The system protocol identifier for the DSM protocols, as a uint8. Valid values are:

phase

A 16-bit boolean vector of the phases for each channel for the DSM protocols, as a boolean vector. Note that 22ms DSM2 does not support phases, but 11ms DSM2 and all speeds of DSMX do.

flg

The flags from the S.BUS frame, as a uint8.

Parameters and Dialog Box

Main Pane

The Main pane of the dialog appears as follows:

URI of serial receiver

The URI of the serial receiver. The URI typically refers to a serial port to which the receiver is connected. See the configuration options above for settings appropriate for each protocol.

Protocol

Indicates which protocol is being used. The block can autodetect between protocol variants, although error checking may be less stringent when autodetection between protocol variants is used.

Map minimum to (tunable online)

The values in a frame range typically range from 0 to 1023 or 0 to 2047 for each raw channel. This parameter is a scalar or vector used to transform the input before writing it to the ch output. A zero raw channel value in the frame will map to the value specified in this parameter. Other values will map linearly up to the value specified in the Map maximum to parameter.

If a vector is specified, then each element of the vector is used for the corresponding channel. If the vector is shorter than 16 elements, then the last element is used for the remaining channels.

Map maximum to (tunable online)

The values in a frame range typically range from 0 to 1023 or 0 to 2047 for each raw channel. This parameter is a scalar or vector used to transform the input before writing it to the ch output. The maximum raw value in the frame will map to the value specified in this parameter. Other values will map linearly down to the value specified in the Map minimum to parameter.

If a vector is specified, then each element of the vector is used for the corresponding channel. If the vector is shorter than 16 elements, then the last element is used for the remaining channels.

Synchronization byte(s) (tunable online)

Determines the synchronization value(s) used to detect the start of an S.BUS frame. The block will validate the synchronization byte to ensure the frame is properly received. This value is typically 0x0f in hexadecimal (or 15 decimal). If this argument is a vector then each element in the vector will be treated as a valid synchronization byte.

This parameter is only visible when an S.BUS protocol is selected.

External remote (tunable offline)

Indicates whether the receiver is an internal or external remote, since the DSM protocol varies slightly when an external remote is used.

This parameter is only visible when a DSM protocol is selected.

Advanced Pane

The Advanced pane of the dialog appears as follows:

Receive thread priority (tunable offline)

The priority of the receive thread that is used to receive frames from the serial receiver. Higher priority values indicate higher priority. A priority of zero is the lowest priority.

Signal Attributes Pane

The Signal Attributes pane of the dialog appears as follows:

Channel output data type

Sets the data type of the ch output.

Targets

See Also

• Serial Receiver Write block

Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.

Link to this page.