Skip to content

RZ: Set White Channel (binary), EXP Bus Protocol Reference

Understanding EXP board addressing

This command is used with FAST Expansion and FAST breakout boards via a FAST Serial Protocol (FSP) connection to the EXP Bus. Please read the EXP Overview to understand the operation of these commands and addresses.

This command is used to set the white channel for individual RGBW LEDs. You can chain together multiple LEDs and values in a single command.

This is a binary command, meaning its designed to be used by your game software talking to the FAST EXP Bus, rather than for humans using an interactive terminal emulator. (A version of this command that uses all ASCII characters is available via RW:.)

Command Syntax

RZ:<count>[<index><w>...]

<count>

One byte, the binary count of how many LEDs will be updated via this command. This is needed since this command is binary, so the EXP processor needs to know the count of how much binary data to look for before it goes back to looking for ASCII characters. Valid ranges are 0-127 (binary 0x00 - 0x7F) since that's the max LEDs that can be attached to a single breakout board.

<index>

This is a single byte number for the LED you want to update. Individual LEDs are numbered (0-127) (binary 0x00 - 0x7F) since that's the max LEDs that can be attached to a single breakout board.

New in firmware 0.20:

You can also use mapped LED blocks which you configured via the LM: command. In this case, all the LEDs in that set will be updated to the same color as if they were a single LED.

If LED maps have previously been created on the expansion board targetted, then LED indexes 80-FF correspond to the mapped LED sets.

<w>

Value of the white channel as a single byte, in the range of 0-255 (binary 0x00 - 0xFF).

Examples

You can update more than one LED at a time with this command by putting commas between each LED.

For example, to update three LEDs:

  • LED 01 - no white (00)
  • LED 10 - half white (80)
  • LED 2B - full white (ff)

The payload of this command would look like this before it was encoded to bytes:

03010010802BFF

Breaking it down:

  • 03 we are updating 3 LEDs in this command
  • 0110 set LED 01 white channel to 00
  • 1080 set LED 10 white channel to 80
  • 2BFF set LED 2B white channel to FF
  • No <CR> at the end!

But what would actually be sent over the wire is this:

RZ:<raw bytes data that would look weird when printed>

Since this command is binary, there are no commas separating LEDs and no <CR> at the end of it. (The "count" value tells the EXP Processor how many more bytes are coming, so the <CR> is not needed.)

If you have a global fade rate set (via a previously-sent RF: command for the board the LEDs are attached to), then the LEDs will fade to the target color over the set time.

Note this command has a 50ms timeout which cancels it if has not received all of the data within that time.

Return Response

None

N or > jump the next page, P or < for previous, search with S or ?