diff --git a/README.md b/README.md index d952a2f..ff1753f 100644 --- a/README.md +++ b/README.md @@ -3,44 +3,36 @@ Can bus monitoring tool based on arduino and can bus shield. Implements CAN ASCI See protocol definition here http://www.can232.com/docs/can232_v3.pdf and here http://www.can232.com/docs/canusb_manual.pdf -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// -// Commands not supported/not implemented: -// s, W, M, m, U -// -// Commands modified: -// S - supports not declared 83.3 rate straight away (S9) -// refer to https://github.com/latonita/CAN_BUS_Shield fork with 83.3 support, easy to add. -// F - returns MCP2515 error flags -// Z - extra Z2 option enables 4 byte timestamp vs standard 2 byte (60000ms max) -// -////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// -// CODE SUPPORTED SYNTAX DESCRIPTION -// -#define LW232_CMD_SETUP 'S' // YES+ Sn[CR] Setup with standard CAN bit-rates where n is 0-8. - // S0 10Kbit S4 125Kbit S8 1Mbit - // S1 20Kbit S5 250Kbit S9 83.3Kbit - // S2 50Kbit S6 500Kbit - // S3 100Kbit S7 800Kbit -#define LW232_CMD_SETUP_BTR 's' // - sxxyy[CR] Setup with BTR0/BTR1 CAN bit-rates where xx and yy is a hex value. -#define LW232_CMD_OPEN 'O' // YES O[CR] Open the CAN channel in normal mode (sending & receiving). -#define LW232_CMD_LISTEN 'L' // YES L[CR] Open the CAN channel in listen only mode (receiving). -#define LW232_CMD_CLOSE 'C' // YES C[CR] Close the CAN channel. -#define LW232_CMD_TX11 't' // YES tiiildd...[CR] Transmit a standard (11bit) CAN frame. -#define LW232_CMD_TX29 'T' // YES Tiiiiiiiildd...[CR] Transmit an extended (29bit) CAN frame -#define LW232_CMD_RTR11 'r' // YES riiil[CR] Transmit an standard RTR (11bit) CAN frame. -#define LW232_CMD_RTR29 'R' // YES Riiiiiiiil[CR] Transmit an extended RTR (29bit) CAN frame. -#define LW232_CMD_POLL_ONE 'P' // YES P[CR] Poll incomming FIFO for CAN frames (single poll) -#define LW232_CMD_POLL_MANY 'A' // YES A[CR] Polls incomming FIFO for CAN frames (all pending frames) -#define LW232_CMD_FLAGS 'F' // YES+ F[CR] Read Status Flags. -#define LW232_CMD_AUTOPOLL 'X' // YES Xn[CR] Sets Auto Poll/Send ON/OFF for received frames. -#define LW232_CMD_FILTER 'W' // - Wn[CR] Filter mode setting. By default CAN232 works in dual filter mode (0) and is backwards compatible with previous CAN232 versions. -#define LW232_CMD_ACC_CODE 'M' // - Mxxxxxxxx[CR] Sets Acceptance Code Register (ACn Register of SJA1000). // we use MCP2515, not supported -#define LW232_CMD_ACC_MASK 'm' // - mxxxxxxxx[CR] Sets Acceptance Mask Register (AMn Register of SJA1000). // we use MCP2515, not supported -#define LW232_CMD_UART 'U' // YES Un[CR] Setup UART with a new baud rate where n is 0-6. -#define LW232_CMD_VERSION1 'V' // YES v[CR] Get Version number of both CAN232 hardware and software -#define LW232_CMD_VERSION2 'v' // YES V[CR] Get Version number of both CAN232 hardware and software -#define LW232_CMD_SERIAL 'N' // YES N[CR] Get Serial number of the CAN232. -#define LW232_CMD_TIMESTAMP 'Z' // YES+ Zn[CR] Sets Time Stamp ON/OFF for received frames only. EXTENSION to LAWICEL: Z2 - millis() timestamp w/o standard 60000ms cycle -#define LW232_CMD_AUTOSTART 'Q' // YES todo Qn[CR] Auto Startup feature (from power on). +Commands not supported/not implemented: s, W, M, m, U +Commands modified: + S - supports not declared 83.3 rate, refer to https://github.com/latonita/CAN_BUS_Shield fork + F - returns MCP2515 error flags + Z - extra Z2 option enables 4 byte timestamp vs standard 2 byte (60000ms max) + + +'S' // YES+ Sn[CR] Setup with standard CAN bit-rates where n is 0-8. + // S0 10Kbit S4 125Kbit S8 1Mbit + // S1 20Kbit S5 250Kbit S9 83.3Kbit + // S2 50Kbit S6 500Kbit + // S3 100Kbit S7 800Kbit +'s' // - sxxyy[CR] Setup with BTR0/BTR1 CAN bit-rates where xx and yy is a hex value. +'O' // YES O[CR] Open the CAN channel in normal mode (sending & receiving). +'L' // YES L[CR] Open the CAN channel in listen only mode (receiving). +'C' // YES C[CR] Close the CAN channel. +'t' // YES tiiildd...[CR] Transmit a standard (11bit) CAN frame. +'T' // YES Tiiiiiiiildd...[CR] Transmit an extended (29bit) CAN frame +'r' // YES riiil[CR] Transmit an standard RTR (11bit) CAN frame. +'R' // YES Riiiiiiiil[CR] Transmit an extended RTR (29bit) CAN frame. +'P' // YES P[CR] Poll incomming FIFO for CAN frames (single poll) +'A' // YES A[CR] Polls incomming FIFO for CAN frames (all pending frames) +'F' // YES+ F[CR] Read Status Flags. +'X' // YES Xn[CR] Sets Auto Poll/Send ON/OFF for received frames. +'W' // - Wn[CR] Filter mode setting. By default CAN232 works in dual filter mode (0) and is backwards compatible with previous CAN232 versions. +'M' // - Mxxxxxxxx[CR] Sets Acceptance Code Register (ACn Register of SJA1000). // we use MCP2515, not supported +'m' // - mxxxxxxxx[CR] Sets Acceptance Mask Register (AMn Register of SJA1000). // we use MCP2515, not supported +'U' // YES Un[CR] Setup UART with a new baud rate where n is 0-6. +'V' // YES v[CR] Get Version number of both CAN232 hardware and software +'v' // YES V[CR] Get Version number of both CAN232 hardware and software +'N' // YES N[CR] Get Serial number of the CAN232. +'Z' // YES+ Zn[CR] Sets Time Stamp ON/OFF for received frames only. EXTENSION to LAWICEL: Z2 - millis() timestamp w/o standard 60000ms cycle +'Q' // YES todo Qn[CR] Auto Startup feature (from power on).