vedirect_protocol:faq
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
vedirect_protocol:faq [2016-05-29 09:42] – mvader | vedirect_protocol:faq [2023-03-31 12:04] (current) – mvader | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== VE.Direct Protocol FAQ ======= | + | ====== VE.Direct Protocol FAQ ====== |
+ | ===== 1. Introduction ===== | ||
More information on the VE.Direct protocol is available here: | More information on the VE.Direct protocol is available here: | ||
* [[https:// | * [[https:// | ||
Line 6: | Line 7: | ||
* [[open_source: | * [[open_source: | ||
- | ===== FAQ ===== | + | Note that, besides a FAQ, this page also contains a framehandler reference implementation in C code. See at the bottom. |
- | === Can I use RS232 instead of USB? === | + | |
+ | From a hardware point of view, our VE.Direct ports have four pins: positive, TX, RX and GND. The TX and RX go (almost) directly into the UART of the microcontroller of the product. | ||
+ | |||
+ | To connect directly to such port, we advise to use either our VE.Direct to USB interface, or our VE.Direct to RS232 interface. Both include galvanic isolation circuitry. Having such isolation is important, as in the product itself (ie. in the solar charger, bmv battery monitor, inverter and so forth) there is very little protection. | ||
+ | |||
+ | More information, | ||
+ | |||
+ | |||
+ | ===== 2. FAQ ===== | ||
+ | ==== Q1: Can I use RS232 instead of USB? ==== | ||
Yes, use the //VE.Direct to RS232 interface//, | Yes, use the //VE.Direct to RS232 interface//, | ||
- | === When using the VE.Direct to RS232 interface, what pins do I need? === | + | ==== Q2: When using the VE.Direct to RS232 interface, what pins do I need? ==== |
For the communication use the GND, RX and TX pins: pin 5, 2 and 3 on the DB9 connector. | For the communication use the GND, RX and TX pins: pin 5, 2 and 3 on the DB9 connector. | ||
Also the DTR signal (pin 4 on the DB9 connector) and/or the RTS signal (pin 7 on the DB9 connector) must be driven high to power the isolated side of the the interface. How to program the DTR and RTS differs between used operating systems and hardware. Please note that most RS232 drivers are inverting so the logic level of the DTR must be programmed to zero in most cases. When one of those pins is not driven high, you will not be able to receive data! | Also the DTR signal (pin 4 on the DB9 connector) and/or the RTS signal (pin 7 on the DB9 connector) must be driven high to power the isolated side of the the interface. How to program the DTR and RTS differs between used operating systems and hardware. Please note that most RS232 drivers are inverting so the logic level of the DTR must be programmed to zero in most cases. When one of those pins is not driven high, you will not be able to receive data! | ||
- | Background: the VE.Direct to RS232 interface provides galvanic isolation between the VE.Direct product and the host (your computer/ | + | Background: the "VE.Direct to RS232 interface |
When using an external power supply to power DTR or RTS, the minimum voltage is 5V, and maximum is 12V. Note that it is normally not necessary to use an external power supply for this: normal serial ports will either automatically drive DTR or RTS high. And if not that, than you can control those pins to be high from within the software. | When using an external power supply to power DTR or RTS, the minimum voltage is 5V, and maximum is 12V. Note that it is normally not necessary to use an external power supply for this: normal serial ports will either automatically drive DTR or RTS high. And if not that, than you can control those pins to be high from within the software. | ||
- | === How do I calculate the HEX checksum? === | + | ==== Q3: How do I calculate the HEX checksum? |
I have been able to get the data I need from the sensor (BMV-700H), as show in your examples (im quoting your last email below): | I have been able to get the data I need from the sensor (BMV-700H), as show in your examples (im quoting your last email below): | ||
Consider the following example: | Consider the following example: | ||
Line 36: | Line 46: | ||
So in code you can loop through the message as in the following pseudo code: | So in code you can loop through the message as in the following pseudo code: | ||
+ | < | ||
byte checksum = 0x55; | byte checksum = 0x55; | ||
byte message[] = { 0x7, 0xff, 0x0f, 0x00 }; | byte message[] = { 0x7, 0xff, 0x0f, 0x00 }; | ||
for (int i =0; i < sizeof(message); | for (int i =0; i < sizeof(message); | ||
- | | + | checksum -= message[i]; |
+ | </ | ||
+ | Example using a Get Command | ||
+ | < | ||
Get command: | Get command: | ||
: | : | ||
Line 46: | Line 60: | ||
Get Soc, register 0x0FFF | Get Soc, register 0x0FFF | ||
: | : | ||
+ | </ | ||
+ | ==== Q4: Is the VE.Direct interface 3.3 or 5V ? ==== | ||
+ | It depends on the product: some are 5v, others 3v3. | ||
+ | |||
+ | The circuits in our panels and USB interfaces work on both voltages. And they automatically adapt their TX voltage to the voltage level coming from the VE.Direct product (bmv/ | ||
+ | |||
+ | List of the products: | ||
+ | |||
+ | * BMV-700: 3v3 | ||
+ | * MPPT all models: 5v | ||
+ | * Newer MPPTs (as now under development) will be 5V. | ||
+ | * MPPT RS, Multi RS, any other RS: 3v3 | ||
+ | * VE.Direct Inverters 250…500VA - 3V3 | ||
+ | * VE.Direct Inverters 800VA & 1200VA 3V3 | ||
+ | * Smart Inverters 1600VA...5000VA - 3V3 | ||
+ | |||
+ | ==== Q5: How much current can I draw from the power pin in the VE.Direct port? ==== | ||
+ | Max 10mA average, with max 20mA/5ms bursts. | ||
+ | |||
+ | ==== Q6: What is the end of line character when sending a HEX message? ==== | ||
+ | |||
+ | This question concerns the situation of your software sending a HEX message to a Victron device, such as a BMV. | ||
+ | |||
+ | As also documented in the HEX protocol documents, the end of line character is '' | ||
+ | |||
+ | ==== Q7: How about frequency of transmitting HEX messages ==== | ||
+ | |||
+ | How often you send a HEX message doesn' | ||
+ | |||
+ | ==== Q8: How do I calculate the TEXT checksum? ==== | ||
+ | |||
+ | I need to get data from a BMV, but how do I check the data integrity? The [[https:// | ||
+ | |||
+ | **Answer: | ||
+ | Consider the following output: | ||
+ | < | ||
+ | PID 0x203 | ||
+ | V 26201 | ||
+ | I 0 | ||
+ | P 0 | ||
+ | CE 0 | ||
+ | SOC 1000 | ||
+ | TTG -1 | ||
+ | Alarm OFF | ||
+ | Relay OFF | ||
+ | AR 0 | ||
+ | BMV 700 | ||
+ | FW 0307 | ||
+ | Checksum � | ||
+ | </ | ||
+ | And as a raw data dump: | ||
+ | < | ||
+ | 00000000 | ||
+ | 00000010 | ||
+ | 00000020 | ||
+ | 00000030 | ||
+ | 00000040 | ||
+ | 00000050 | ||
+ | 00000060 | ||
+ | </ | ||
+ | The checksum needs to be calculated from the start (0d) till the end of the frame, including the checksum value from the frame (d8). | ||
+ | |||
+ | In code you can loop through the message as in the following pseudo code: | ||
+ | <code c> | ||
+ | int checksum = 0; | ||
+ | char message[] = { ... }; | ||
+ | for (int i = 0; i < message.length; | ||
+ | | ||
+ | } | ||
+ | |||
+ | if (checksum == 0) { | ||
+ | /* Checksum is valid => process message */ | ||
+ | | ||
+ | } else { | ||
+ | /* Invalid checksum => reject message */ | ||
+ | } | ||
+ | </ | ||
+ | ===== 2. Framehandler reference implementation ===== | ||
+ | |||
+ | This the main data receival routine of our consumer stack that both handles TEXT and HEX messages. | ||
+ | |||
+ | <code cpp> | ||
+ | #include " | ||
+ | |||
+ | #include < | ||
+ | #include < | ||
+ | #include < | ||
+ | |||
+ | #define MODULE " | ||
+ | |||
+ | // The name of the record that contains the checksum. | ||
+ | static constexpr char checksumTagName[] = " | ||
+ | |||
+ | VeDirectFrameHandler:: | ||
+ | mStop(true), | ||
+ | mState(IDLE), | ||
+ | mChecksum(0), | ||
+ | mTextPointer(0) | ||
+ | { | ||
+ | } | ||
+ | |||
+ | void VeDirectFrameHandler:: | ||
+ | { | ||
+ | if (mStop) return; | ||
+ | if ( (inbyte == ':' | ||
+ | mState = RECORD_HEX; | ||
+ | } | ||
+ | if (mState != RECORD_HEX) { | ||
+ | mChecksum += inbyte; | ||
+ | } | ||
+ | inbyte = toupper(inbyte); | ||
+ | |||
+ | switch(mState) { | ||
+ | case IDLE: | ||
+ | /* wait for \n of the start of an record */ | ||
+ | switch(inbyte) { | ||
+ | case ' | ||
+ | mState = RECORD_BEGIN; | ||
+ | break; | ||
+ | case ' | ||
+ | default: | ||
+ | break; | ||
+ | } | ||
+ | break; | ||
+ | case RECORD_BEGIN: | ||
+ | mTextPointer = mName; | ||
+ | *mTextPointer++ = inbyte; | ||
+ | mState = RECORD_NAME; | ||
+ | break; | ||
+ | case RECORD_NAME: | ||
+ | // The record name is being received, terminated by a \t | ||
+ | switch(inbyte) { | ||
+ | case ' | ||
+ | // the Checksum record indicates a EOR | ||
+ | if ( mTextPointer < (mName + sizeof(mName)) ) { | ||
+ | *mTextPointer = 0; /* Zero terminate */ | ||
+ | if (strcmp(mName, | ||
+ | mState = CHECKSUM; | ||
+ | break; | ||
+ | } | ||
+ | } | ||
+ | mTextPointer = mValue; /* Reset value pointer */ | ||
+ | mState = RECORD_VALUE; | ||
+ | break; | ||
+ | default: | ||
+ | // add byte to name, but do no overflow | ||
+ | if ( mTextPointer < (mName + sizeof(mName)) ) | ||
+ | *mTextPointer++ = inbyte; | ||
+ | break; | ||
+ | } | ||
+ | break; | ||
+ | case RECORD_VALUE: | ||
+ | // The record value is being received. | ||
+ | switch(inbyte) { | ||
+ | case ' | ||
+ | // forward record, only if it could be stored completely | ||
+ | if ( mTextPointer < (mValue + sizeof(mValue)) ) { | ||
+ | *mTextPointer = 0; // make zero ended | ||
+ | textRxEvent(mName, | ||
+ | } | ||
+ | mState = RECORD_BEGIN; | ||
+ | break; | ||
+ | case ' | ||
+ | break; | ||
+ | default: | ||
+ | // add byte to value, but do no overflow | ||
+ | if ( mTextPointer < (mValue + sizeof(mValue)) ) | ||
+ | *mTextPointer++ = inbyte; | ||
+ | break; | ||
+ | } | ||
+ | break; | ||
+ | case CHECKSUM: | ||
+ | { | ||
+ | bool valid = mChecksum == 0; | ||
+ | if (!valid) | ||
+ | logE(MODULE," | ||
+ | mChecksum = 0; | ||
+ | mState = IDLE; | ||
+ | frameEndEvent(valid); | ||
+ | break; | ||
+ | } | ||
+ | case RECORD_HEX: | ||
+ | if (hexRxEvent(inbyte)) { | ||
+ | mChecksum = 0; | ||
+ | mState = IDLE; | ||
+ | } | ||
+ | break; | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
===== DISQUS ===== | ===== DISQUS ===== | ||
~~DISQUS~~ | ~~DISQUS~~ | ||
+ |
vedirect_protocol/faq.1464507771.txt.gz · Last modified: 2016-05-29 09:42 by mvader