ShiftX2
Introduction
Parts in the Kit
In the kit you will receive:
- ShiftX2 module
- 4 wire pigtail
- Acrylic enclosure
- Mounting screws with o-rings
Installation
ShiftX2 is designed to be surface mounted with the included enclosure, or it can be embedded into your dashboard in a custom installation.
Assembling the enclosure
- plug the wiring pigtail into the socket on ShiftX2. The plug is keyed to insert in one direction, with the red wire to the left.
- Thread the pigtail through the hole in the bottom layer of the acrylic enclosure (1/8" black plastic plate).
- Place ShiftX2 onto the bottom layer, stack the 1/4" middle frame on top, with the clearance notch over the connector, and finally the top clear lens.
- Place the two o-rings onto the mounting screws - these cushion the mounting points of ShiftX2 - and place them into mounting holes, passing through all 3 layers of the enclosure.
Mounting ShiftX2
Mount ShiftX2 to your dashboard surface using the following template: ((picture))
- Note: Ensure the hole for the wiring is deburred and has no sharp edges.
Attach ShiftX2 with the mounting screws and tighten until snug and the o-rings are compressed.
- Note: Do not overtighten to prevent cracking of the acrylic enclosure.
Wiring
Pinout
Color | Assignment | Notes |
---|---|---|
Red | 5-12v Power | Connect this to switched ignition power. 0.5A max consumption. |
Black | CAN High | |
Yellow | CAN Low | |
Black | Ground |
CAN Termination
CAN termination is enabled by default. To disable termination, cut the CAN Term jumper on the bottom of ShiftX2.
Powering and Connecting to RaceCapture
To power ShiftX2, connect the Red wire to switched 12v, and the white wire to Ground.
- You can use the same circuit for your RaceCapture system so they power up simultaneously.
Connect the black wire to CAN High, and the yellow wire to CAN Low.
- Note You can choose either CAN1 or CAN2 to drive ShiftX2. The CAN bus can be defined in the script you use to control ShiftX2.
Scripts
Disco Lights Demo
This is a test script that exercises all of the LEDs on ShiftX2. You can use this as a first time test, as it does not rely on any sensors.
Script
Copy and paste this entire script into the scripting window, replacing any existing script.
sxCan = 0 sxId=0 tickRate=30 sxBright=0 function rndc() return math.random(0,255) end function sxOnUpdate() for i=0,9,1 do r = rndc() g = rndc() b = rndc() sxSetLed(i,1,r,g,b,0) end end function sxOnBut(d) println('button: ' ..d[1]) end function sxOnInit() print('sx onInit') end --ShiftX2 library functions-- function sxSetLed(i,l,r,g,b,f) sxTx(10,{i,l,r,g,b,f}) end function sxSetLinearThresh(id,s,th,r,g,b,f) sxTx(41,{id,s,spl(th),sph(th),r,g,b,f}) end function sxSetAlertThresh(id,tid,th,r,g,b,f) sxTx(21,{id,tid,spl(th),sph(th),r,g,b,f}) end function setBaseConfig(bright) sxTx(3,{bright}) end function setAlert(id,r,g,b,f) sxTx(20,{id,r,g,b,f}) end function updateAlert(id,v) if v~=nil then sxTx(22,{id,spl(v),sph(v)}) end end function sxCfgLinearGraph(rs,ls,lr,hr) sxTx(40,{rs,ls,spl(lr),sph(lr),spl(hr),sph(hr)}) end function updateLinearGraph(v) sxTx(42,{spl(v),sph(v)}) end function sxInit() println('config shiftX2') setBaseConfig(sxBright) if sxOnInit~=nil then sxOnInit() end end function sxChkCan() id,ext,data=rxCAN(sxCan,0) if id==sxCanId then sxInit() end if id==sxCanId+60 and sxOnBut~=nil then sxOnBut(data) end end function sxProcess() sxChkCan() if sxOnUpdate~=nil then sxOnUpdate() end end function sxTx(offset, data) txCAN(sxCan, sxCanId + offset, 1, data) sleep(10) end function spl(v) return bit.band(v,0xFF) end function sph(v) return bit.rshift(bit.band(v,0xFF00),8) end function onTick() sxProcess() end sxCanId = 0xE3600 + (256 * sxId) println('shiftx2 base id ' ..sxCanId) setTickRate(tickRate) sxInit() end
Shift Light + Twin Alert Example
(this script is a complete example that does a sequential shift light + two alert indicators)
Script
Copy and paste this entire script into the scripting window, replacing any existing script.
function onTick() --implement me end
Predictive Lap Timer Indicator
This script enables predictive lap time visualization.
How it works
A bar extends left or right from the center of the linear graph:
- Green bar extending to the right indicates you're beating the best time
- Orange bar extending to the left means you're falling behind.
Script
Copy and paste this entire script into the scripting window, replacing any existing script.
function onTick() --implement me end
Boost Gauge
This script visualizes a single analog input channel on the linear graph.
How it works
The script configures the linear graph, then reads an analog channel and updates the graph with the current value. In this case, the value represents boost level measured from a MAP sensor.
Script
Copy and paste this entire script into the scripting window, replacing any existing script.
function onTick() --implement me end
Only Alerts
This script enables 3 alert channels:
- Left alert for oil pressure
- Right alert for engine temperature
- Center alert for Air/Fuel ratio
How it works
The script configures the left and right alert indicators, then configures the center graph to visualize safe and dangerous AFR ranges. During operation, the analog channels for oil pressure and engine temperature are read and updates the alert indicators. The AFR channel is read and updates the linear graph.
Script
Copy and paste this entire script into the scripting window, replacing any existing script.
function onTick() --implement me end
ShiftX2 starter script
Use this as a starter for your own custom script
---ShiftX2 functions--- --=============== --Reference. Delete me to save space --=============== --function sxSetLed(index,length,red,green,blue,flash) --Set an individual LED --index: LED index, starting at 0 --length: number of LEDs to set at once --red: Red value (0-255) --green: Green value (0-255) --blue: Blue value(0-255) --flashHz: Flash rate, in Hz; 0=no flash --sxSetLinearThresh(thresholdId,segmentLength,thresholdValue,red,green,blue,flashHz) --Setup a threshold for the linear graph --thresholdId: Threshold ID to set. from 0-4. define in ascending order. --segmentLength: Length of the segment when in stepped graph mode. ignored for smooth mode. --thresholdValue: Value for this threshold. --red: Red value (0-255) --green: Green value (0-255) --blue: Blue value (0-255) --flashHz: Flash rate, in Hz; 0=no flash --sxSetAlertThresh(alertId,thresholdId,thresholdValue,red,green,blue,flashHz) --Setup a threshold for an alert indicator --alertId: Id of the alert to configure --thresholdId: Threshold ID to set. from 0-4. define in ascending order. --thresholdValue: Value for this threshold. --red: Red value (0-255) --green: Green value (0-255) --blue: Blue value (0-255) --flashHz: Flash rate, in Hz; 0=no flash --setAlert(alertId,red,green,blue,flashHz) --Directly sets an alert indicator --alertId: Alert Id to set --red: Red value (0-255) --green: Green value (0-255) --blue: Blue value (0-255) --flashHz: Flash rate, in Hz; 0=no flash --updateAlert(alertId,currentValue) --Updates Current alert value, using the previously configured thresholds --alertId: Alert Id to set --currentValue: Updated value --sxCfgLinearGraph(renderStyle,linearStyle,lowRange,highRange) --Configures the linear graph --renderStyle: 0=left->right, 1=center,2=right->left --linearStyle: 0=smooth/interpolated, 1=stepped --lowRange: low range of the graph --highRange: high range of the graph (ignored if stepped linear style) --updateLinearGraph(currentValue) --Updates the linear graph value, using the previously configured thresholds --currentValue: Updated value --=============== --End reference --=============== function sxSetLed(i,l,r,g,b,f) sxTx(10,{i,l,r,g,b,f}) end function sxSetLinearThresh(id,s,th,r,g,b,f) sxTx(41,{id,s,spl(th),sph(th),r,g,b,f}) end function sxSetAlertThresh(id,tid,th,r,g,b,f) sxTx(21,{id,tid,spl(th),sph(th),r,g,b,f}) end function setBaseConfig(bright) sxTx(3,{bright}) end function setAlert(id,r,g,b,f) sxTx(20,{id,r,g,b,f}) end function updateAlert(id,v) if v~=nil then sxTx(22,{id,spl(v),sph(v)}) end end function sxCfgLinearGraph(rs,ls,lr,hr) sxTx(40,{rs,ls,spl(lr),sph(lr),spl(hr),sph(hr)}) end function updateLinearGraph(v) sxTx(42,{spl(v),sph(v)}) end function sxInit() println('config shiftX2') setBaseConfig(sxBright) if sxOnInit~=nil then sxOnInit() end end function sxChkCan() id,ext,data=rxCAN(sxCan,0) if id==sxCanId then sxInit() end if id==sxCanId+60 and sxOnBut~=nil then sxOnBut(data) end end function sxProcess() sxChkCan() if sxOnUpdate~=nil then sxOnUpdate() end end function sxTx(offset, data) txCAN(sxCan, sxCanId + offset, 1, data) sleep(10) end function spl(v) return bit.band(v,0xFF) end function sph(v) return bit.rshift(bit.band(v,0xFF00),8) end function onTick() sxProcess() end sxCanId = 0xE3600 + (256 * sxId) println('shiftx2 base id ' ..sxCanId) setTickRate(tickRate) sxInit()
ShiftX2 CAN bus API
Overview
The CAN bus API provides the configuration and control interface for ShiftX2.
Two styles of control are available:
- Low level control of LEDs - the ability to discretely set LED color and flash behavior
- High level control - configuring alert thresholds and linear graph up front, and then providing simple value updates
CAN Messages
CAN base ID
CAN base ID is 0xE3600 (931328)
Cutting the jumper ADR1 will add 256 to the base ID, allowing up to two ShiftX2 displays on the same CAN bus.
CAN Baud rate
500K and 1MB rates are supported.
500K is enabled by default; cut the jumper ADR2 on the bottom of ShiftX2 to enable 1MB.
Configuration / Runtime Options
Announcement
Broadcast by the device upon power up
CAN ID: Base + 0
Offset | What | Value |
---|---|---|
0 | Total LEDs | Total number of LEDs on the device |
1 | Alert Indicators | Number of logical alert indicators |
2 | Linear Bar Graph Length | Number of LEDs in linear graph |
3 | Major Version | Firmware major version number |
4 | Minor Version | Firmware minor version number |
5 | Patch Version | Firmware patch version number |
Reset Device
Resets the device, loading defaults
CAN ID: Base + 1
Offset | What | Value |
---|---|---|
(no data) |
Statistics
Statistics information, broadcast periodically by device
CAN ID: Base + 2
Offset | What | Value |
---|---|---|
0 | Major Version | Firmware major version number |
1 | Minor Version | Firmware minor version number |
2 | Patch Version | Firmware patch version number |
Set Configuration Parameters Group 1
Sets various configuration options.
CAN ID: Base + 3
Offset | What | Value |
---|---|---|
0 | Brightness | 0 - 100; default = 0 (0=automatic brightness) |
1 | Automatic brightness scaling (Optional) | 0-255; default=51 |
Set Discrete LED
A low level function to directly set any LED on the device.
CAN ID: Base + 10
Offset | What | Value |
---|---|---|
0 | LED index | 0 -> # of LEDs on device |
1 | Number of LEDs to set | 0 -> # of LEDs on device (0 = set all remaining) |
2 | Red | 0 - 255 |
3 | Green | 0 - 255 |
4 | Blue | 0 - 255 |
5 | Flash | 0-10Hz (0 = full on) |
Alert Indicators
Alert Indicators are typically single LEDs or a group of LEDs treated as one logical unit. This is defined by the hardware configuration of the device.
Set Alert
Directly set an alert indicator
CAN ID: Base + 20
Offset | What | Value |
---|---|---|
0 | Alert ID | 0 -> # of Alert indicators |
1 | Red | 0 - 255 |
2 | Green | 0 - 255 |
3 | Blue | 0 - 255 |
4 | Flash | 0-10Hz (0 = full on) |
Set Alert Threshold
Configures an alert threshold. Up to 5 thresholds can be configured per alert indicator.
Notes:
- Threshold value must be > 0 to be valid
- Alerts are processed in descending order by Threshold ID, where:
- The threshold is selected where the threshold is > 0 and current value is >= threshold and < than the next threshold
- If the current value is greater than the last threshold, then the last threshold is selected.
- If the current value is less than the first threshold, then the alert indicator is disabled.
CAN ID: Base + 21
Offset | What | Value |
---|---|---|
0 | Alert ID | 0 -> # of Alert indicators |
1 | Threshold ID | 0 - 4 |
2 | Threshold (low byte) | |
3 | Threshold (high byte) | |
4 | Red | 0 - 255 |
5 | Green | 0 - 255 |
6 | Blue | 0 - 255 |
7 | Flash Hz | 0 - 10 (0 = full on) |
Update Current Alert Value
Updates the current value for an alert indicator. The configured alert thresholds will be applied to the current value.
CAN ID: Base + 22
Offset | What | Value |
---|---|---|
0 | Alert ID | 0 -> # of Alert indicators |
1 | Value (low byte) | |
2 | Value (high byte) |
Linear Graph
The linear graph mode provides visualizations for common scenarios:
- Sequential RPM shift light where the progression is stepped
- Linear bar graph to linearly indicate a sensor value
- Center left/right graph to indicate +/- performance against a reference - such as visualizing current predictive time vs best time
Power up default configuration
Upon power up the linear graph is configured:
- Rendering style: left->right
- Linear style: stepped
- Low Range: 0
- High Range: N/A
- Threshold :
- Threshold value: 3000 / segment length: 3 / color RGB: (0, 255, 0) / flash: 0
- Threshold value: 5000 / segment length: 5 / color RGB: (0, 255, 255) / flash: 0
- Threshold value: 7000 / segment length: 7 / color RGB: (255, 0, 0) / flash: 5
Configure Linear Graph
Configures the options for the linear graph portion of the device.
Rendering style:
- If left->right, linear graph illuminates left to right
- If centered, values below the mid-point in the range extend from the center to the left, and values above the mid-point extend from the center to the right.
- If right->left, linear graph illuminates right to left
Linear style:
- if smooth, graph length is updated smoothly by interpolating the current value in-between LEDs
- If stepped, creates the visual effect of stepped progressions by setting the segment length of the threshold configuration. High Range of configuration is ignored.
CAN ID: Base + 40
Offset | What | Value |
---|---|---|
0 | Rendering Style | 0 = left->right, 1=center, 2=right->left |
1 | Linear Style | 0 = Smooth / interpolated, 1 = stepped |
2 | Low Range (low byte) | |
3 | Low Range (high byte) | |
4 | High Range (low byte) | (ignored if linear style = stepped) |
5 | High Range (high byte) | (ignored if linear style = stepped) |
Set Linear Graph Threshold
Configures a linear threshold. Up to 5 thresholds can be configured
CAN ID: Base + 41
Offset | What | Value |
---|---|---|
0 | Threshold ID | 0 - 4 |
1 | Segment Length | 0 -> # of LEDs on device (ignored if linear style is ‘smooth’) |
2 | Threshold (low byte) | |
3 | Threshold (high byte) | |
4 | Red | 0 - 255 |
5 | Green | 0 - 255 |
6 | Blue | 0 - 255 |
7 | Flash Hz | 0 - 10 (0 = full on) |
Update Current Linear Graph Value
Updates the current value for the linear graph
CAN ID: Base + 42
Offset | What | Value |
---|---|---|
0 | Value (low byte) | |
1 | Value (high byte) |
Notifications
Notifications related to events broadcasted from ShiftX2
Button State
Indicates a change in the button state
CAN ID: Base + 60
Offset | What | Value |
---|---|---|
0 | Button state | 1 = button is pressed; 0 = button |