diff --git a/docs/Makefile b/docs/Makefile old mode 100755 new mode 100644 diff --git a/docs/conf.py b/docs/conf.py old mode 100755 new mode 100644 diff --git a/docs/index.rst b/docs/index.rst old mode 100755 new mode 100644 index 7e4594b6..965d8e83 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,6 +37,13 @@ Contents eval/user-guide/index +.. toctree:: + :caption: Apps & Solutions + :maxdepth: 4 + + solutions/application-software/index + solutions/reference-designs/index + .. toctree:: :caption: University Program :maxdepth: 4 @@ -56,3 +63,6 @@ Contents contributing/forking_publishing contributing/creating_new_pages contributing/docs_guidelines + + + \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat old mode 100755 new mode 100644 diff --git a/docs/solutions/application-software/index.rst b/docs/solutions/application-software/index.rst new file mode 100644 index 00000000..224cf4ba --- /dev/null +++ b/docs/solutions/application-software/index.rst @@ -0,0 +1,13 @@ +Application Software (Sample Page) +------------------------ + + +.. toctree:: + :titlesonly: + :glob: + + */index + + +This is a placeholder page for a reference design application software. + diff --git a/docs/solutions/index.rst b/docs/solutions/index.rst new file mode 100644 index 00000000..5c13e03d --- /dev/null +++ b/docs/solutions/index.rst @@ -0,0 +1,25 @@ +:orphan: + +Applications and Solutions +============================= + +.. toctree:: + :maxdepth: 4 + + +Application Software +------------------------------------------------------------------------------- + +.. toctree:: + :maxdepth: 2 + + application-software/index + + +Reference Designs +------------------------------------------------------------------------------- + +.. toctree:: + :maxdepth: 2 + + reference-designs/index \ No newline at end of file diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/72v-96v_vehicle_system.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/72v-96v_vehicle_system.png new file mode 100644 index 00000000..15af3f97 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/72v-96v_vehicle_system.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25f8afa9a07b6db0d93d6caf6af19a842218bc188514bc8e73e7f0e8bca7d29c +size 205879 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/AD-BMSE2E3W-SL-UG-2245.pdf b/docs/solutions/reference-designs/ad-bmse2e3w-sl/AD-BMSE2E3W-SL-UG-2245.pdf new file mode 100644 index 00000000..4cc1edf2 Binary files /dev/null and b/docs/solutions/reference-designs/ad-bmse2e3w-sl/AD-BMSE2E3W-SL-UG-2245.pdf differ diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/Components.csv b/docs/solutions/reference-designs/ad-bmse2e3w-sl/Components.csv new file mode 100644 index 00000000..af5d76df --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/Components.csv @@ -0,0 +1,16 @@ +No.,Part,Function +1,Battery Cell Connector,Connector going to battery cells +2,ADBMS6830 (U1),BMS 1 Cell Monitoring Chip with LPCM capability +3,ADBMS6830 (U3),BMS 2 Cell Monitoring Chip with LPCM capability +4,NTC Provision (U1),Connector for Negative Temperature Coefficient (NTC) Thermistor in ADBMS6830 (U1) +5,NTC Provision (U3),Connector for Negative Temperature Coefficient (NTC) Thermistor in ADBMS6830 (U3) +6,ADBMS2950 (U5),Voltage Pack and Current Pack Monitor Chip +7,ADBMS6822 (U10),Dual isoSPI chip +8,VBAT+ Connector,Positive Terminal Connector for total voltage capacity of the battery pack +9,Rsense Pack Monitor,Resistor Sensing for detecting and monitoring total current in the pack +10,72V to 96V LINK+_OUT Load Connector,Connector going to the load side of the system +11,72V to 96V LINK+_IN Charger Connector,Connector going to the charging side of the system +12,CAN Connector,"Three terminal connector provision for CAN_H, CAN_L, and GND communication" +13,Micro USB Supply Provision,5V DC USB supply provision +14,UART/SWDIO Connector,Connector for UART/SWDIO communication. Can be used to download program and debugging +15,MAX32690 MCU Chip,Low power/high power MCU chip used as controller for the system diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/Specifications.csv b/docs/solutions/reference-designs/ad-bmse2e3w-sl/Specifications.csv new file mode 100644 index 00000000..9d0880e5 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/Specifications.csv @@ -0,0 +1,37 @@ +SYSTEM,,,,, +Parameter,Min,Typical,Max,Unit,Notes +System Vin+ Supply Voltage from Battery,60,,100,V,Input voltage supply from battery +Battery Emulator System Output Voltage,~66,,92,V,Safe output voltage from Battery Emulator +Current Discharge,,50,100,A,Current rating that the BMS can deliver at discharge mode +Current Charge,0.3,50,100,A,Current rating that the BMS can deliver at pre-charge/charge mode +Pre-Charge Resistor,,3×33,,Ω, +Charge Voltage Input,,,100,V, +Discharge Voltage Output,,65,92,V,Regulated voltage range +FET Discharge Rise Time,,,42,mS, +FET Driver Discharge Input,,,5,V,Coming from GPIO of ADBMS2950 +FET Pre-Charge/Charge Rise Time,,,88,mS, +FET Driver Pre-Charge/Charge Input,,,5,V,Coming from GPIO of ADBMS2950 +FET V(gs) range,-20,,20,V,Coming from GPIO of ADBMS2950 +FET Rds(on) range,,,4.8,mΩ,Coming from GPIO of ADBMS2950 +ADBMS6830 Cell Monitor,,,,, +"Total Supply Voltage, V+ to V−",-0.3,,85,V, +VREG Supply,4.5,5,5.5,V, +"VREF1, VREF2",3,,3.3,,Supply to internal ADCs +VRES/VDD,4.5,5,5.5,V, +Temp,-40,,125,°C, +CPIN Input Range,-2.5,,5.5,V, +Cell Count,17,,32,,Min of 17 cells for the system to initiate daisy chain +Drive,-0.3,,7,V,Drive voltage range with respect to each cell monitoring V- +ADBMS2950 Pack Monitor,,,,, +Main Supply Voltage In,14,,,V, +VREG Pack Monitor,4.5,5,5.5,V, +"Current Input S1A, I1A, I1B",-4,,4,V, +"Current Input S1A, I1A, I1B",-4,,4,V, +"Current Input S2A, I2A, I2B",-4,,4,V, +"Current Input I3A, I3B",-4,,4,V, +MAX32690 Microcontroller,,,,, +MCU Supply Voltage from BMS,3.3,,5.5,V, +MCU IO Supply for 1.8 V,1.6,,3,V, +MCU VDD Supply,3.3,,5.5,V, +MCU Supply at 1.2 V,1.1,,1.35,V, +MCU Supply at 1.0 V,0.9,,1.2,V, diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl-designsupport.zip b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl-designsupport.zip new file mode 100644 index 00000000..39027c9e Binary files /dev/null and b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl-designsupport.zip differ diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_angle.jpg b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_angle.jpg new file mode 100644 index 00000000..11796f05 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_angle.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bcbf6405bfafa3f7669a4f7c790099051e867dfa294c35ceb9c83db78a2bf9a4 +size 67535 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_package_contents.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_package_contents.png new file mode 100644 index 00000000..fa65385b --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/ad-bmse2e3w-sl_package_contents.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32a7b23bc15f4f59ffd1f5f07a1ae5f1214bb9a8b5ffd93de35d4a3e1bedda44 +size 1819751 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/basic_can_comm.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/basic_can_comm.png new file mode 100644 index 00000000..19329e69 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/basic_can_comm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83ee52796fb9689f7b921dc4f0578be0b7467313489dfab749614ba677cda071 +size 35310 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/battery_emulator_pins.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/battery_emulator_pins.png new file mode 100644 index 00000000..f2a1424f --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/battery_emulator_pins.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3a7319b1467892f91efd45f980f2be31db9e8bf843cbedf2e9bc1248fe1b7a91 +size 308885 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/connector_supply_vbattp.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/connector_supply_vbattp.png new file mode 100644 index 00000000..18ff613d --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/connector_supply_vbattp.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9884ab5eba97a05e6b83c7cb3d089410a54d3f3ddf66c2e59024237fabae69aa +size 726941 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/dual_side_cell_depopulation.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/dual_side_cell_depopulation.png new file mode 100644 index 00000000..6563eb5a --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/dual_side_cell_depopulation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b33ec829589281ca267707ff7be43ff8a93712ef5a502441445fba613c419b9 +size 72057 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/gnd_vbat-_to_gnd_sense.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/gnd_vbat-_to_gnd_sense.png new file mode 100644 index 00000000..7421cd15 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/gnd_vbat-_to_gnd_sense.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d795f933023b47b5cc382e15fb3ef156dd56c527e3669ddb287449be78742056 +size 735540 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/index.rst b/docs/solutions/reference-designs/ad-bmse2e3w-sl/index.rst new file mode 100644 index 00000000..bd78e766 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/index.rst @@ -0,0 +1,267 @@ + +=========================== +AD-BMSE2E3W-SL +=========================== + + +A concise version of this document is available in portable document format. Click on the file below to download: + +.. ADMONITION:: Download + + `AD-BMSE2E3W-SL QuickStart Guide (pdf) `_ + + + + +Overview +---------- + +The AD-BMSE2E3W-SL is a BMS reference design for light electric vehicles (LEVs). With a voltage range of 72 V to 96 V, this solution is suitable for electric 2-wheeler and 3-wheeler vehicles with high current capacity ranging up to 100 A. + +This single-board system utilizes the best-in-class ADBMS6830 cell monitoring chip that is capable of monitoring up to 2x 16-channel. This board also features battery pack monitoring using the ADBMS2950. The ADBMS6822 dual isoSPI transceiver provides a built-in 2-wire reversible isoSPI connection, which simplifies the communication of BMS parts in a daisy chain configuration before sending the data to SPI lines in the microcontroller. + +The on-board MAX32690 MCU, when loaded with the firmware, can perform BMS measurements such as cell voltage (average and filtered), and pack voltage and pack current measurement. The board also has a charge, pre-charge, and discharge mode that can be controlled by the ADBMS2950 pack monitor chip. + +The AD-BMSE2E3W-SL is designed to perform either in embedded mode or using a GUI, where it calculates the battery's State of Charge (SoC) and State of Health (SoH) through enhanced coulomb counting technique. + + +.. image:: ad-bmse2e3w-sl_angle.jpg + + + +Features +--------- + +- Variable 72 V to 96 V regulated voltage range, suitable for E2W/E3W applications +- ASIL-D compliant and automotive grade BMS chip +- Built-in charge/pre-charge, and discharge circuitry +- 1.8 mV total measurement error for cell voltage monitoring +- High performance cell/pack voltage and current monitoring +- On-board isoSPI communication +- Low Power Cell Monitoring (LPCM) capability +- GPIO Controllable FET Monitoring +- ADBMS6830 GPIO input ready for NTC sensors +- Low Power MAX32690 MCU +- UART and CAN Communication +- SOC and SOH through Enhanced Coulomb Counting Technique +- E2W/E3W Basic System Behavior Modes +- Embedded Application-ready (via CLI) +- GUI capable of the following measurements and fault detection: + - Cell Monitoring Voltage and Current + - Pack Monitoring Charge Current Monitoring + - Discharge Current Monitoring + - Temperature Monitoring + - Cell OV/UV Detection + - Cell/GPIO Open-wire Detection + - Cell Balancing + + +Applications +------------ + +- Electric and hybrid 2-wheeler vehicles +- Electric and hybrid 3-wheeler vehicles +- Light electric vehicles + + + +System Architecture +-------------------- +.. image:: updated_block_diagram_72vto96v.png + + + +.. csv-table:: Specifications + :file: Specifications.csv + :widths: 20, 10, 10, 10, 10, 40 + :header-rows: 1 + + +What's Inside the Box? +------------------------- + +Upon purchase of the AD-BMSE2E3W-SL kit, the package comes with the following boards and accessories: + +.. image:: ad-bmse2e3w-sl_package_contents.png + + + +Components and Connections +---------------------------- + +.. image:: revised_ad-bmse2e3w-sl_board_with_pin_labels.png + +.. csv-table:: Hardware Part Functions + :file: Components.csv + :widths: 5, 25, 70 + :header-rows: 1 + + + +System Evaluation +------------------------- + +Follow the setup shown in the diagram below to get the board up and running. Ensure that the hardware parts and equipment are complete based on list of Equipment Needed. The banana plug cables used in this setup only have a maximum rating of 10A. Cables suitable for higher current rating must be used if the intended application operates at range higher than 10A. Note that the AD-BMSE2E3W-SL board can only accommodate up to 100A. + +.. image:: system_evaluation_set-up.png + + +Equipment Needed +^^^^^^^^^^^^^^^^^ + +- 1x AD-BMSE2E3W-SL Board +- 2x DC2472A Battery Cell Emulator Boards +- 1x MAX32625PICO Programming Adapter with 10-pin SWD cable (loaded with firmware image) +- 2x Cell Connector Block (18-cell connector) +- 2x USB Type A to Micro-B cable +- 2x Stackable Banana Plug to Alligator Clip Cable (BU-P1166-12-2, Red) +- 1x Stackable Banana Plug to Alligator Clip Cable (BU-P1166-12-0, Black) +- 7x Top Mount Heatsink (to be installed for high current applications) +- 1x Laptop or PC running Windows 10 + + +.. ADMONITION:: WARNING + + This reference design has not undergone compliant testing for EMI/ EMC standards for automotive. It is up for the user to do its qualification as the requirements vary depending on its end application or use cases. + + +.. ADMONITION:: ESD + + All the products described on this page include ESD (electrostatic discharge) sensitive devices. Electrostatic charges as high as 4000 V readily accumulate on the human body or test equipment and can discharge without detection. + + Although the boards feature ESD protection circuitry, permanent damage may occur on devices subjected to high-energy electrostatic discharges. Therefore, proper ESD precautions are recommended to avoid performance degradation or loss of functionality. This includes removing static charge on external equipment, cables, or antennas before connecting to the device. + + + +.. note:: For high current applications requiring greater than 50 A, it is advisable to install a heat sink to protect the pre-charge, charge, and discharge MOSFETs from overheating. + + + - The AD-BMSE2E3W-SL Kit has 7 available HEATSINK PIN-FIN W/TAPE (375424B00034G) easy-to-install, adhesive type, aluminum top mount heat sink than can be installed directly on top of the board. + + - Peel off the protective film from the bottom of each heat sink and firmly press each one on top of the following FETs: + + (1) Attach the 5 heat sinks on the top layer of the board (Q4, Q5, Q6, Q7, and Q9), + (2) the remaining 2 heat sinks on the bottom layer of the board (Q3 and Q8). + + + +Preparing the MCU +------------------- + +By default (upon purchase), the AD-BMSE2E3W-SL board comes with a MAX32625PICO programmer adapter that is loaded with firmware image. + +Otherwise, if you are using a new MAX32625PICO programmer (that is not part of the original kit), make sure to flash it first with the correct firmware image before connecting it to the AD-BMSE2E3W-SL board. If you do not know how to load the image, follow the instructions below: + +1. Download the firmware image: `MAX32625PICO Firmware Image for MAX32690 `_ + +2. Do not connect the MAX32625PICO to the AD-BMSE2E3W-SL Board yet. + +3. Connect the MAX32625PICO to the Host PC using the micro USB to USB cable. + +4. Press the button on the MAX32625PICO. (Do not release the button until the MAINTENANCE drive is mounted) + +5. Release the button once the MAINTENANCE drive is mounted. + +6. Drag and drop (to the MAINTENANCE drive) the firmware image. + +7. After a few seconds, the MAINTENANCE drive will disappear and be replaced by a drive named DAPLINK. This indicates that the process is complete, and the MAX32625PICO can now be used to flash the firmware of the AD-BMSE2E3W-SL Board. + + + +Hardware Setup +---------------- +The board utilizes the DC2472A battery emulator as input for cell voltage measurement. The DC2472A allows a cell voltage of 1.4 V (min) to 4.2 V (max). Follow below steps to set up the board for cell measurement: + + +1. Screw the two cell connector blocks to the two DC2472A battery emulators. Note that the first two terminals and the last terminal of each DC2472A cell connector must be left hanging (refer to below figure). Make sure to also set the last two terminals' input to low voltage or equivalent range of roughly 1.4V per cell. + + .. image:: battery_emulator_pins.png + +2. Connect the DC2472A battery emulators to the ADBMSE2E3W-SL board through the cell connector blocks. Then, connect a micro-USB Type B cable to each DC2472A battery emulator and power the boards by connecting the other end of the cables to the Host PC. + + .. image:: usb_emulator.png + +3. Set the DC2472A battery emulators to the lowest voltage by fully turning the Cell Voltage Adjustment Potentiometer counterclockwise. + +4. Attach the MAX32625PICO programmer to the AD-BMSE2E3W-SL board using the 10-pin ribbon SWD cable. Power the MAX32625PICO using a micro-USB to USB cable connected to the Host PC. + + .. image:: max32625_power_usb_pc.png + +5. Connect the alligator clip cable (red) to the VBATTP Pin or the 3rd of Pin 17 header of the DC2472A battery emulator. Then insert the other end of the cable (banana jack plug) to TP16 (VBAT+ terminal) of the AD-BMSE2E3W-SL board. + + .. image:: connector_supply_vbattp.png + +6. Connect the alligator clip cable (black) to the GND (VBAT-) supply of the DC2472A battery emulator. Then, connect the other end of the cable to the Rsense (top side) of the AD-BMSE2E3W-SL. + + .. image:: gnd_vbat-_to_gnd_sense.png + +7. Set the DC2472A battery emulators to HIGH voltage or equivalent to 4.1 V per cell by turning the Cell Voltage Adjustment Potentiometer clockwise. + +8. Check the supply for the following test points as described in the diagram and table below. Make sure that the voltage levels are within the specified range. + + .. image:: quick_test_points.png + + .. csv-table:: Hardware Supply Quick Test Point + :file: test-points.csv + :widths: 15, 30, 35, 20 + :header-rows: 1 + + +9. Once all steps are completed, you are now ready to use this reference design and run the accompanying software found in the link below: + + .. note:: The AD-BMSE2E3W-SL comes complete with firmware examples and easy-to-use application GUI. Access the software resources and see the setup procedure in the AD-BMSE2E3W-SL Software User Guide. + + + +Resources +------------ + +- `ADBMS6830 Product Page `_ +- `ADBMS2950 Product Page `_ +- `ADBMS6822 Product Page `_ +- `MAX32690 Product Page `_ +- `LT8303 Product Page `_ +- `ADUM225N Product Page `_ +- `LTC7001 Product Page `_ +- `LTC3639 Product Page `_ + + + +Design & Integration Files +-------------------------- + +.. ADMONITION:: Download + + `AD-BMSE2E3W-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + +:: + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + +---------------------------------------------------------------------------------------------------------- + +Up Next... + + +.. toctree:: + :maxdepth: 2 + :caption: Software Guide + + software_guide/index + +.. toctree:: + :maxdepth: 2 + :caption: Sample Application + + sample_application/index + diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/load_diagram.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/load_diagram.png new file mode 100644 index 00000000..cb1d0d7b --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/load_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa22dec0c1ac9d9ad1b41d9ef851f220f69604fbd654a295d47f1318d9942b87 +size 37663 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/max32625_power_usb_pc.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/max32625_power_usb_pc.png new file mode 100644 index 00000000..1fe4f41d --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/max32625_power_usb_pc.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3bdb886f9005a0cab879898e77147f450ee8319898f862b872dd314ced531eaf +size 724769 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/quick_test_points.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/quick_test_points.png new file mode 100644 index 00000000..87102eaa --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/quick_test_points.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08012a387ca24d9b4e7fc04de90a1b803df43f7e21036b198351a5f5525e8a5f +size 17301114 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/revised_ad-bmse2e3w-sl_board_with_pin_labels.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/revised_ad-bmse2e3w-sl_board_with_pin_labels.png new file mode 100644 index 00000000..d0eb3a83 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/revised_ad-bmse2e3w-sl_board_with_pin_labels.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e4f245ccde0072f7aa07b457f34bb52e1b176a7549c8b8a2c5b656c8d70fa329 +size 5197951 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/72v-96v_vehicle_system.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/72v-96v_vehicle_system.png new file mode 100644 index 00000000..15af3f97 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/72v-96v_vehicle_system.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:25f8afa9a07b6db0d93d6caf6af19a842218bc188514bc8e73e7f0e8bca7d29c +size 205879 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/basic_can_comm.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/basic_can_comm.png new file mode 100644 index 00000000..19329e69 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/basic_can_comm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:83ee52796fb9689f7b921dc4f0578be0b7467313489dfab749614ba677cda071 +size 35310 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/dual_side_cell_depopulation.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/dual_side_cell_depopulation.png new file mode 100644 index 00000000..6563eb5a --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/dual_side_cell_depopulation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b33ec829589281ca267707ff7be43ff8a93712ef5a502441445fba613c419b9 +size 72057 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/index.rst b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/index.rst new file mode 100644 index 00000000..2db2de49 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/index.rst @@ -0,0 +1,53 @@ +Sample Application +=================== + +72V to 96V Light EV Basic System Application +---------------------------------------------- + +Below diagram depicts the essential components needed when using this BMS reference design for basic electric 2-wheeler or 3-wheeler applications. Each block represents a component. Use the diagram as a guide to understand the system operation. + +.. image:: 72v-96v_vehicle_system.png + + +1. **Battery Cell/Pack Block** - This block is where your battery supply or source is located. There are two configurations on how to connect the battery cells to the BMS: + + + **Single Side Cell Depopulation** + + .. image:: single_side_cell_depopulation.png + + + **Dual Side Cell Depopulation** + + .. image:: dual_side_cell_depopulation.png + + + .. note:: The setup shown in this User Guide uses the single side depopulation method only in connecting/aligning the cell to the BMS. The dual side depopulation is not yet supported by the software. + + + +2. **BMS Block** - This block is where the BMS Cell and Pack Monitoring and MCU control happens. This block is also responsible for the control of the **Charging** (if the battery needs to be charged) and **Discharging** (when the battery needs to deliver voltage output going to the load side). + + +3. **User Interface Display** - This block is where the measurement, diagnosis, and status of the BMS are displayed. The Display can have two options (or you can use both): + + **UART Communication** + + .. image:: uart_comm.png + + **CAN-BASIC Communication** + + .. image:: basic_can_comm.png + + + .. note:: For the BASIC CAN setup, we use the `PCAN-USB connector `_ as our CAN interpreter. This product is **not included** in the AD-BMSE2E3W-SL Kit and needs to be purchased separately. + + +4. **Load** - This block is where you can place your external load. The voltage output at this level can vary from 72V to 96V with 50A to 100A range current capacity. The system implements a low side current sensing using Rshunt (sense resistor) where the VBAT- of the battery is connected to the upper end of the Rshunt bar and Shunt- is connected to the lower end of the Rshunt. The Shunt- will then be connected to the end of the load or the negative supply of the load. + + .. image:: load_diagram.png + + + +After the set up for vehicle and load connection is done, you can now load the sample firmware for vehicle application. + diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/load_diagram.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/load_diagram.png new file mode 100644 index 00000000..cb1d0d7b --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/load_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa22dec0c1ac9d9ad1b41d9ef851f220f69604fbd654a295d47f1318d9942b87 +size 37663 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/single_side_cell_depopulation.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/single_side_cell_depopulation.png new file mode 100644 index 00000000..6250e0e1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/single_side_cell_depopulation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ca2671e428263a1c8db19e2c09b192b3de97a917aeb40ecfb58fcc99ed9906e +size 65873 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/uart_comm.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/uart_comm.png new file mode 100644 index 00000000..fc61ecb2 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/uart_comm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c08063a8adce1944e17b69c13b922b27046f1ee612eeaf6d71503dcaa8e17be +size 36519 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/single_side_cell_depopulation.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/single_side_cell_depopulation.png new file mode 100644 index 00000000..6250e0e1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/single_side_cell_depopulation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ca2671e428263a1c8db19e2c09b192b3de97a917aeb40ecfb58fcc99ed9906e +size 65873 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/background_script.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/background_script.png new file mode 100644 index 00000000..a31a2ad3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/background_script.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e47f15caff1f569ee64be2c0dcd56ca411b0c7c7b328caf5ca31f7ae2c06b99a +size 67650 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_jumper_selection.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_jumper_selection.png new file mode 100644 index 00000000..d68c70c5 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_jumper_selection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:098ea601a93119b608aad8996a59d1d5ba6309fbca62d4e0a63c18fae186c152 +size 219678 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_mode.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_mode.png new file mode 100644 index 00000000..3d5ddac6 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/communication_mode.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c96b5dbb7703cd1a195b517785789dd054086e574f6d5a209babcfddfad2117 +size 118451 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/firmware_location.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/firmware_location.png new file mode 100644 index 00000000..e2ed40a1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/firmware_location.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20c124e480ea0745698a101713b892c5854966391f723b6f0c8169850ad4e7ec +size 51759 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file.png new file mode 100644 index 00000000..769e4f84 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5721ce9d6f3a073a6bf56d397613e023cabfe42e7da1ccce546041af829beada +size 60250 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file_location.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file_location.png new file mode 100644 index 00000000..a388926e --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_executable_file_location.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b59fa7c9332bca8ff4ac0649f9d50a0017af46c2c6d138779b6e64525481f5c9 +size 235619 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_installation.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_installation.png new file mode 100644 index 00000000..842d2e37 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/gui_installation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a45613325176ca1b4e5a38249017065c81ff432b53888b998cc4385740b2eec3 +size 107622 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/hex_file_to_daplink.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/hex_file_to_daplink.png new file mode 100644 index 00000000..3333ffbd --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/hex_file_to_daplink.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2910ce773ab6d813417bdfd972d6dfcaa8ecc564488fa498fce0611f4812e179 +size 195823 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_details.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_details.png new file mode 100644 index 00000000..d48df470 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_details.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb356f06b2ca8bfb75a68167ce10b42278834ec0835881315003235e36734710 +size 83886 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_page.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_page.png new file mode 100644 index 00000000..db54bfb1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/home_landing_page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c7d8d5b8b9a83f9c4717fc77dfdc312e99eae505cc1728ccf0573389639d8fd +size 93570 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/index.rst b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/index.rst new file mode 100644 index 00000000..72105da8 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/index.rst @@ -0,0 +1,181 @@ +Software User Guide +============================ + + + +Requirements +------------- + + * Host PC (Windows 10 or later) + * with administrator and internet access + * 1920 by 1080 or greater screen resolution, recommended + + + +The **AD-BMSE2E3W-SL GUI** also referred as the **Light EV BMS GUI** is a PC-based Graphical User Interface (GUI) tool designed to work in conjunction with the AD-BMSE2E3W-SL board. + +**MyAnalog.com account is required to download the software**. + +Follow the steps below to create a MyAnalog account: + +1. Go to `MyAnalog `_ and create an account using email. Select the **Register with email** option to get started. + +2. Once you have a MyAnalog account, log in to `MyAnalog `_ using your credentials. + + + + +Request for Software Access +------------------------------ + +.. note:: Send the following details to this email address to request for software access: + + **LEV_CSESupport@analog.com** + + * MyAnalog email address + * Company + * Country + * Purpose/Projects + + + +Software Download +-------------------- + +1. Click this link: `AD-BMSE2E3W-SL Version 1.0.0 `_ + +2. You will be directed to the *Software Package Download* page. Tick the checkbox and click the **I Accept** button to indicate acceptance of the license agreement. + +3. Click the ``Download`` button to download the installer. + +.. note:: When software updates or new versions of the software are available, Analog Devices sends a notification to the email address associated with the MyAnalog account used to download the original software package. + + + + +GUI Installation +-------------------------- + + +1. Double-click on **ad-bmse2e3w-sl-rel1.0.0.exe** to install the program to your computer. + + .. image:: gui_executable_file.png + + +2. Accept the license terms and click *Next* to proceed with the installation. The default installation directory is in ``C:\Analog Devices\`` + + .. image:: gui_installation.png + + +3. Locate the **light_ev_bmsv1.0.0.hex** file inside the AD-BMSE2E3W-SL installer files folder. + + ``C:\Analog Devices\AD-BMSE2E3W-SL-Rel1.0.0\Software\Firmware`` + + .. image:: firmware_location.png + + +4. Drag and drop the .hex file into the DAPLink drive to flash the program on the MCU. + + .. image:: hex_file_to_daplink.png + + +5. Find the **Light_EV_BMS_GUI.exe** file inside the AD-BMSE2E3W-SL installer files folder. + + ``C:\Analog Devices\AD-BMSE2E3W-SL-Rel1.0.0\Software\GUI\Light_EV_BMS_GUI_v1.0.0`` + + .. image:: gui_executable_file_location.png + + +6. Double-click the **Light_EV_BMS_GUI.exe** file to open the program. You should see a script running in the background separately and the landing page running in the browser. + + .. image:: background_script.png + + .. image:: home_landing_page.png + + + + +Interface Setup +------------------- + + .. image:: home_landing_details.png + + .. csv-table:: Details Available on the Landing Page + :file: landing-page.csv + :widths: 10, 20, 70 + :header-rows: 1 + + + +1. Set the jumper configuration based on the communication mode being used: UART or CAN. + + .. image:: communication_jumper_selection.png + + On the GUI landing page, hover to the *Communication Mode* dropdown menu. Select **UART COM** followed by the specific port number if using UART, or **CAN** if using CAN. + + .. image:: communication_mode.png + + + Press the ``RESET`` button every time the hardware set up is changed. + + .. image:: reset_button_hardware.png + + +2. Click the ``Load Defaults`` button to set the initial entry values for the different parameters needed for the State of Charge (SoC) and State of Health (SoH) calculations. + + .. image:: setting_defaults.png + + +3. Click the ``Start`` button to begin the measurements. + + .. image:: start_button.png + + + + +Tabs +---------- + +Overview +^^^^^^^^^^ + +The Overview tab features plots for stack voltage, module current, max charge current, max discharge current, cell voltages, cell temperatures, and state of the battery. This tab also allows setting of the vehicle state, which by default is set to "PARKED". + +.. image:: update_overview_page.png + + +Graph +^^^^^^^^ + +The Graph tab enables checking the progression of the readings for different parameters such as the cell voltage, temperature, SoC, SoH, and pack voltage and current. + +.. image:: update_graph_page.png + + +Console +^^^^^^^^^ + +Presents the actual numerical data being fetched by the UI in a tabular form. This tab allows the user to study or qualify the data, if needed. + +.. image:: update_console_page.png + + +Diagnostic +^^^^^^^^^^^^ + +This tab enables the user to check any anomaly detected by the BMS devices. Some of these diagnostic functions are cell overvoltage and undervoltage, open wire detection, and others. + + Indicators: + * Green color = passed (or no issue detected) + * Red color = failed + + .. image:: update_diagnsotic_page.png + + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/landing-page.csv b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/landing-page.csv new file mode 100644 index 00000000..41f89699 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/landing-page.csv @@ -0,0 +1,8 @@ +No.,Function,Definition +1,Connection Indicator,Shows if UART or CAN is connected +2,Communication Mode Drop Down,Allows selection of the communication mode +3,Vehicle System Mode,"Contains a dropdown list for vehicle system states such as parked, driving, charging, and fault" +4,Refresh Button,Updates the list of available communication ports +5,Battery Specifications,Input boxes for battery specifications which are used for SoC and SoH +6,Load Defaults Button,Sets the battery specification values to the predefined default program entries +7,Start Button,Initiates battery monitoring and directs users to the Overview page diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/reset_button_hardware.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/reset_button_hardware.png new file mode 100644 index 00000000..d03ad169 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/reset_button_hardware.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb6ecf0b3644ca64799b5bee1cd7be68aa843f1d6286efa965d6f5e46e4dfb9e +size 341820 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/setting_defaults.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/setting_defaults.png new file mode 100644 index 00000000..9884c644 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/setting_defaults.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b672857f47c466058dc14e144607d69b8caf9628d5ff39748c549c82cdce18f +size 463662 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/start_button.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/start_button.png new file mode 100644 index 00000000..e313b25d --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/start_button.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6a8a4ea32b43a9add8c97e7de1fa47f102a6c84dbb9e7b9300d34abecc0b9d1 +size 497619 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_console_page.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_console_page.png new file mode 100644 index 00000000..86e676ed --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_console_page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2d63275afe0a04d6a65b413c91668d893275de52c2fccb1316a0a351a5f44818 +size 122289 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_diagnsotic_page.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_diagnsotic_page.png new file mode 100644 index 00000000..c1873703 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_diagnsotic_page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1bc3090d55a04c04948f46cdfa89931c9b31d80e278ab2a6a06f0f92f3b24e11 +size 137535 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_graph_page.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_graph_page.png new file mode 100644 index 00000000..61d6fe1b --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_graph_page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:377d908a25aa3be5f0db514c908d0ad83c46f57dd185dbc1128f45d1f3e7388f +size 114958 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_overview_page.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_overview_page.png new file mode 100644 index 00000000..42ec8a1c --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/update_overview_page.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:498bdf752ed24bc622238068da2f15b28c204e4a3b322af0ba36888a3a81750b +size 3673673 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/system_evaluation_set-up.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/system_evaluation_set-up.png new file mode 100644 index 00000000..654d1853 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/system_evaluation_set-up.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:244f9382cb125360f806e56237ca055fab5991a5c0ae5310ccb39b824a22a8a2 +size 392795 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/test-points.csv b/docs/solutions/reference-designs/ad-bmse2e3w-sl/test-points.csv new file mode 100644 index 00000000..1f5b8d4c --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/test-points.csv @@ -0,0 +1,9 @@ +TP Name,Description,Function,Voltage Range +TP2,U1 ADBMS6830 BMS1_VREG,U1 Input Voltage BMS1_VREG for ADBMS6830,Low voltage: 15 V to 20 V +,,,High voltage: (50 V to 58 V) +TP4,U3 ADBMS6830 BMS2_VREG,U3 Input Voltage BMS2_VREG input for ADBMS6830,0 V to 5 V +TP7,U6 LTC3639 Output,U6 LTC3639 Regulator Voltage Output,4.5 V to 5.5 V +TP8,U9 LT8303 Output,U9 LT8303 Switch Down Regulator Output,3.2 V to 3.5 V +R346,U15 MAX25301A Output,U15 MAX25301A Output 3.3 V going to MCU,3.2 V to 3.5V +(Left Pin),,, +TP16,VBAT+,Total Voltage Supply from battery,72 V to 92 V (regulated) diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/uart_comm.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/uart_comm.png new file mode 100644 index 00000000..fc61ecb2 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/uart_comm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c08063a8adce1944e17b69c13b922b27046f1ee612eeaf6d71503dcaa8e17be +size 36519 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/updated_block_diagram_72vto96v.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/updated_block_diagram_72vto96v.png new file mode 100644 index 00000000..7968422e --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/updated_block_diagram_72vto96v.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b6a6248f659d12a76db76a6da42db7b86caadad529d7774512b78ef135e2b78f +size 187581 diff --git a/docs/solutions/reference-designs/ad-bmse2e3w-sl/usb_emulator.png b/docs/solutions/reference-designs/ad-bmse2e3w-sl/usb_emulator.png new file mode 100644 index 00000000..389570ca --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/usb_emulator.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:72256641ad735671ae50451acd3e2fa1090bf9384765df693d702480208dc402 +size 628143 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/ADBMS6830_daisychain.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/ADBMS6830_daisychain.png new file mode 100644 index 00000000..60863f3c --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/ADBMS6830_daisychain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:00bca19c66fed8e7744e3d82ab25f77988f2b63ca23707b63ac4fcfa206983f3 +size 532159 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/Cell_Monitoring_Quick_Measure_Plot.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/Cell_Monitoring_Quick_Measure_Plot.png new file mode 100644 index 00000000..965f5fb3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/Cell_Monitoring_Quick_Measure_Plot.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a45152c9c400d5517f71db7bd895aa686fad61c86435056e402a539fc70bd4f8 +size 75309 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/Daisychain_Plots_Tab.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/Daisychain_Plots_Tab.png new file mode 100644 index 00000000..ebeda3d0 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/Daisychain_Plots_Tab.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b5c7a1e623484ca7addb6082c38bc96825b1e710b08553693d69bda629f7a70 +size 224761 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/Pack_Memory_Map.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/Pack_Memory_Map.png new file mode 100644 index 00000000..bd7851b3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/Pack_Memory_Map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0ca67d41398aafa91e4a05487299467ca992daebd3989f98489f7f007dfab8ef +size 161761 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/ad-cellpackbm-sl.jpg b/docs/solutions/reference-designs/ad-cellpackbm-sl/ad-cellpackbm-sl.jpg new file mode 100644 index 00000000..704a3511 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/ad-cellpackbm-sl.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9cc9d95c085dc36d9cb9475366ab1bf6129569830c857350beb20dcad9b48dc +size 96612 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/daisy_chain_connection.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/daisy_chain_connection.png new file mode 100644 index 00000000..a03aff07 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/daisy_chain_connection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99db2efc498299fcb05f894faed7cbfd48918e7c9e654ab3ab12c7d9fa0e58ce +size 113663 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/design_support_package.zip b/docs/solutions/reference-designs/ad-cellpackbm-sl/design_support_package.zip new file mode 100644 index 00000000..e537d9ac Binary files /dev/null and b/docs/solutions/reference-designs/ad-cellpackbm-sl/design_support_package.zip differ diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ADBMS6830_Setup.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ADBMS6830_Setup.png new file mode 100644 index 00000000..c147f0c3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ADBMS6830_Setup.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc4ac8fea60757d6dd3b43d58f059168a006a5eea106fb0bd1c6211e2db2e3d8 +size 353814 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/Kit_Contents.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/Kit_Contents.png new file mode 100644 index 00000000..deca0ebb --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/Kit_Contents.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:15a22c9039cba23f648213cff96345f19e4f2dd5bc0a395ed4c2ac5015c39ad9 +size 9058881 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ad-cellpackbm-sl.jpg b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ad-cellpackbm-sl.jpg new file mode 100644 index 00000000..704a3511 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/ad-cellpackbm-sl.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d9cc9d95c085dc36d9cb9475366ab1bf6129569830c857350beb20dcad9b48dc +size 96612 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/browser_plot_all_devices.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/browser_plot_all_devices.png new file mode 100644 index 00000000..b52c7927 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/browser_plot_all_devices.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cb11b0c834cb3694029484f95cf08c1e9715cd7ff047484a38396bc4d1e3f8c4 +size 78798 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/complete_daisychain.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/complete_daisychain.png new file mode 100644 index 00000000..89acc353 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/complete_daisychain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:750c615ec8648e565f121f0a9857a5b886fc139e23cf8a5164c34ef19423f51b +size 616852 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/daisychain_plot3.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/daisychain_plot3.png new file mode 100644 index 00000000..28cc8bae --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/daisychain_plot3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bfe709b96cdf3bdc97d90aa226c553781b75b4e1a5adc22860e631638e7a9ce2 +size 73468 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/design_support_package.zip b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/design_support_package.zip new file mode 100644 index 00000000..e537d9ac Binary files /dev/null and b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/design_support_package.zip differ diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/index.rst b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/index.rst new file mode 100644 index 00000000..0a552b8a --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/index.rst @@ -0,0 +1,267 @@ +.. _ad-cellpackbm-sl hardware_guide: + + +Hardware User Guide +#################### + +.. toctree:: + :hidden: + + hardware_guide + + +AD-CELLPACKBM-SL +================== + + +System Setup +------------ + +This section describes the procedure for establishing hardware connection between the boards, how to download the system requirements such as the firmware and software, and eventually obtain and view BMS readings through the Broad Market BMS graphical user interface. + + +Equipment Needed +---------------- + +For easy identification of the components included in the kit, refer to the figure below. + +**Boards** + +- 2x EVAL-ADBMS6830BMSW 16-Channel Battery Cell Monitor +- 1x EVAL-ADBMS2950-BASIC Battery Pack Monitor +- 1x EVAL-ADBMS6822 Dual isoSPI Adapter +- 1x EVAL-SDP-CK1Z (SDP-K1) Controller Board +- 2x DC2472A Battery Cell Emulator +- 1x MAX32625PICO Programming Adapter with 10-pin SWD cable (loaded with firmware image) + +**Cables and Other Accessories** + +- 2x Cell Connector Block (18-cell connector) +- 3x DuraClik isoSPI Twisted Pair Cables +- 3x USB Type A to Micro-B Cable +- 2x 12.0“ Alligator Clip / Test Lead, Black +- 1x 12.0” Alligator Clip / Test Lead, Red +- 1x 24.0“ Alligator Clip / Test Lead, Red + +The following list of equipment are not provided as part of the kit, but are required for running the setup described in this guide. + +- Laptop or PC running Windows 10 +- Digital power supply (such as the Keysight e3631A 0V to 6V power supply) +- 2x wall plugs (to plug USB cable from DC2472A to provide power) + + +.. image:: Kit_Contents.png + :align: center + :width: 600px + + +Software +-------- +The BMS Browser GUI is a PC browser based Graphical User Interface (GUI) tool designed to work in conjunction with the hardware in the AD-CELLPACKBM-SL. MyAnalog.com account will be required to download the BMS Browser GUI from below link: + +`BMS Broad Market GUI `_ + +When software updates or new versions of the software are available an email notification will be sent to the email address associated with the MyAnalog account used to download the original software package. + + +MCU Configuration & Setup +-------------------------- + +.. note:: + + By default (upon purchase), the AD-CELLPACKBM-SL Kit comes with a MAX32625PICO programmer adapter that is already loaded with the appropriate firmware image. Otherwise, if you are using a new MAX32625PICO programmer (that is not part of the original kit), make sure to flash it first with the correct firmware image before using it with the AD-CELLPACKBM-SL BMS Kit. If you do not know how to load the image, follow the instructions below. + + + + +The MCU should be programmed using the following steps: + +MAX326825PICO Debugger (One-time setup) + +#. Download and install the BMS Browser GUI Broadmarket. +#. Open the program files folder of the BMS Browser GUI in the host PC and look for the SDP-K1 .bin file. + ``C:\Analog Devices\BMS_Browser_GUI_Broadmarket-Rel2.0.0\USB_TO_SPI_Firmware`` +#. Plug the micro USB cable to the MAX32625PICO. +#. Press the button on the MAX32625PICO and then plug the other end of the micro-USB cable into the PC. A red LED should blink, then hold steady, and a MAINTENANCE drive should appear on your PC. +#. Drag and drop the ``SDP_K1_PyBMS_USB_TO_SPI_Bytes_Debug_USB_Port.bin`` file onto the MAINTENANCE drive. The file transfer should be complete in about 30 seconds. +#. Unplug and replug the device. +#. After completing this step, a **DAPLINK** drive should appear. You can drag and drop the firmware (.bin files separate from the above) onto it to program the SDP-K1. + + + + +BMS Browser GUI Installation +----------------------------- + +#. Download the BMS Browser GUI in your Host PC. +#. Double click on ``bms_browser_gui_broadmarket-relX.Y.Z.exe`` to install the GUI. +#. Accept the license terms and click `Next`` to proceed with the installation. The default installation directory will be in ``C:\Analog Devices\``. + + +Launching the BMS Browser GUI +------------------------------ + +#. Open the BMS Browser GUI either by searching for it in the `Start Menu`` or using the shortcut on the Desktop. +#. Run the application to launch the BMS Browser GUI. +#. Upon launching, a console window will appear to display background information. +#. Two new tabs will open in the default browser on the PC, with the User Guide tab as the default. +#. Switch to the alternative tab to access the BMS Browser configuration page, which should be displayed. +#. Ensure that the SDP-K1 is connected to the PC via the USB-C cable on P10. The Blue LED, D31 will illuminate when powered. +#. In the Serial Port dropdown box, select the COM port associated with SDP-K1. + + +Battery Cell Monitoring +----------------------- + +**Setup** + +.. image:: ADBMS6830_Setup.png + :align: center + :width: 400 px + + +This setup uses the SDP-K1 as the controller board, but users may also use the AD-APARD32690-SL as MCU and follow the same hardware setup instructions. + +The DC2472A Battery Emulator Board was also used for cell voltage input. Alternatively, resistors can be used to simulate battery cell voltages. 100 Ω ½ W or equivalent resistors are recommended because 100 Ω (or lower values) typically will not induce measurement errors, and the ½ W (or greater rating) will keep the resistor temperatures low, preventing power dissipation damage. + +Check the **EVAL-ADBMS6830BMSW** User Guide for procedure on connecting resistors. + +#. Connect the **EVAL-ADBMS6822** dual isoSPI adapter to the EVAL-SDP-CK1Z (SDP-K1) controller board through the Arduino headers. +#. Set the P14 jumper of the SDP-K1 to the 3.3 V position. +#. Connect the SDP-K1 (P2) to the Host PC using a USB cable. +#. Connect the **EVAL-ADBMS6822** (J1) to the **EVAL-ADBMS6830BMSW** (J3) using the 2-wire twisted-pair patch cable from the main DuraClik connector to isoSPI A DuraClik connector. +#. Plug the screw-terminal block(s) into the cell voltage connectors of the **DC2472A** battery emulator board. Note that the last three terminals of the **DC2472A** must be left hanging. +#. Connect the **DC2472A** battery emulator board to the **EVAL-ADBMS6830BMSW** through the connected cell voltage connectors (J1). +#. Power the **DC2472A**** using a 5 V external source connected to J1 using a USB cable. Alternatively, power it through PC using a USB cable to be connected via J10. +#. While some laptop USB ports may suffice for powering the emulator during evaluation, it is still recommended to use an external power supply to ensure adequate power. Note that the EVAL-ADBMS6830BMSW is powered through the **DC2472A**. +#. Attach the **MAX32625PICO** programmer to the SDP-K1 using the 10-pin ribbon SWD cable. Observe correct polarity when connecting the SWD cable. + +**Test** + +#. Open the BMS Browser GUI. +#. Go to the `Interface Connection`` section and select the COM port associated with the SDP-K1. +#. Under the `Daisy Chain`` section, ensure the `Generation`` dropdown box is set to `ADBMSGEN6`. +#. From the `Products list`, select the **ADBMS6830**, then click on the right arrow to add it to the Daisy Chain. Settings can remain as default. +#. Click `Launch`. +#. Upon launching, the `Quick Measure`` tab will open. Note: this utility only supports a single BMS product in a Daisy Chain. Click `Start Quick Measure`` to begin measurements. +#. Check the `Total PEC Status`` on the 3rd row under the `Memory Map`. This indicates the status of the isoSPI link between the **EVAL-ADBMS6822** and the EVAL-ADBMS6830BMSW. +#. Ensure the **EVAL-ADBMS6830BMSW** board is powered correctly, indicated by the Blue LED on the DC2472A being illuminated. +#. Verify the connection of the twisted cable between the **EVAL-ADBMS6822** and the **EVAL-ADBMS6830BMSW**. +#. Check the voltage readings by adjusting the potentiometer (POT1) on the **DC2472A** to modify the emulated cell voltages. Monitor the voltage channels on the `Quick Measure Utility`` graph. Select which signals to display on the graph under the `Plot All Devices`` column. + + +.. image:: browser_plot_all_devices.png + + + +Battery Pack Monitoring +------------------------ + +.. image:: pack_monitoring.png + :align: center + :width: 600 px + + + +**Setup** + +#. Connect the **EVAL-ADBMS6822** dual isoSPI adapter to the **EVAL-SDP-CK1Z (SDP-K1)** controller board through the Arduino headers. +#. Set the P14 jumper of the **SDP-K1** to the 3.3 V position. +#. Connect the **EVAL-ADBMS6822** (J1) to the **EVAL-ADBMS2950-BASIC** (isoA) using the provided isoSPI cable. +#. Choose between two options for powering the **EVAL-ADBMS2950-BASIC**: + - Supply 5 V to J1 and set the current limit to 200 mA. The **EVAL-ADBMS2950-BASIC** consumes less than 50 mA in idle mode and ~100 mA in active mode. + - Alternatively, power it using a micro-USB cable connected to J10. +#. Attach the **MAX32625PICO** programmer to the **SDP-K1** using the 10-pin ribbon SWD cable. Observe correct polarity when connecting the SWD cable. +#. Connect one end of the USB cable to **SDP-K1** (P2) and the other end to the host PC. + + +**Test** + +1. Open the BMS Browser GUI. +2. Go to the `Interface Connection`` section and select the **COM port** associated with the SDP-K1. +3. Under the `Daisy Chain`` section, ensure the `Generation`` dropdown box is set to **ADBMSGEN6**. +4. From the `Products list`, select the **ADBMS2950**, then click on the right arrow to add it to the Daisy Chain. Settings can remain as default. +5. Click `Launch`. +6. Upon launching, the `Quick Measure tab`` will open. Note: it can only handle one BMS product in a Daisy Chain. Click `Start Quick Measure`` to begin measurements. +7. Check the `Total PEC Status`` on the `Memory Map`. It should reflect true, indicating a successful isoSPI link between the **EVAL-ADBMS6822** and the **EVAL-ADBMS2950-BASIC**. If false, there is an error in the signal chain. + + +Complete Daisy Chain +-------------------- + +**Setup** + +.. image:: complete_daisychain.png + :align: center + :width: 600 px + + +Once familiar with the setup for each of the individual boards the entire signal chain can be verified. + +#. Connect the hardware using the DuraClik isoSPI cables, as shown in the diagram below. +#. Power each **DC2472A** battery emulator board using a 5 V external source connected to J1 through the USB cable. +#. Power the **EVAL-ADBMS2950-BASIC** either through J1 or J10, as explained earlier. +#. Using the black alligator clip cable, connect the V- pin of the second **EVAL-ABMS6830BMSW** to the BATT- port of the **EVAL-ADBMS2950-BASIC**. +#. Using the red alligator clip cable, connect the V- pin of the first **EVAL-ABMS6830BMSW** board to the V+ pin of the second **EVAL-ADBMS6830BMSW**. +#. Attach the **MAX32625PICO** programmer to the SDP-K1 using the 10-pin ribbon SWD cable. Observe correct polarity when connecting the SWD cable. +#. Connect one end of the USB cable to SDP-K1 (P2) and the other end to the host PC. + +**Test** + +#. Launch the BMS Browser following the previous instructions and choose the appropriate COM port. +#. Set up the Daisy Chain according to the diagram provided. The **EVAL-ADBMS2950-BASIC** is positioned at the top, indicating it is the initial device on the chain, connected to the **EVAL-ADBMS6822**. The first **EVAL-ADBMS6830BMSW** connects to the **EVAL-ADBMS2950-BASIC**, while the second **EVAL-ADBMS6830BMSW** is linked to the first one via the isoSPI cable. +#. Click on Launch to initiate the GUI. After the GUI launches in the Browser, go to the Sequences tab located in the top toolbar, which will open the Sequence Configuration page. +#. In the `Files`` column, select the **ADBMS6830-ADBMS2950.json**. This action will load a preconfigured sequence into the tool. +#. Click on `Initialization Sequence`` followed by `General Initialization`` under the `Sequences`` column to load the defined sequences from the ADBMS6830-ADBMS2950.json file into the tool. +#. Next, select `Loop Sequence`` and then click on `General Readback Loop`` under the Sequences column. This action loads the loop sequence defined in the ADBMS6830-ADBMS2950.json file into the tool. +#. Finally, click on `Start Freerun`` to initiate the freerun mode. +#. During free run mode, the `Initialization Sequence`` is performed once initially. Subsequently, the loop sequence continues to run continuously until the Stop Freerun button is clicked. +#. After activating freerun mode, navigate to the `Memory Map`` tab. This section displays a numerical representation of the ongoing command loop. Additional details can be accessed in the GUI's help section. The accompanying screenshot illustrates this output. +#. The `Plots`` tab allows for the visualization of parameters recorded during the command loop. It supports the creation of up to four plots simultaneously. + +.. note:: + +In the configured Daisy Chain, the EVAL-ADBMS2950-BASIC is designated as Device 1, the first EVAL-ADBMS6830BMSW as Device 2, and the third EVAL-ADBMS6830BMSW as Device 3. An example illustrates how to plot each parameter separately: I1ACC and I2ACC on Plot 1, the average cell voltages for the first EVAL-ADBMS6830MSW on Plot 2, and the averaged cell voltages for the third EVAL-ADBMS6830BMSW on Plot 3. + + +Simply choose the desired Plot number from the dropdown menu under each device to display the relevant data. + +.. image:: daisychain_plot3.png + + +Plot settings can be saved to the PC to be reloaded for future session to save time. + +--------- + + +Resources +--------- + +* `AD-CELLPACKBM-SL Product Page `_ +* `EVAL-ADBMS6830BMSW Product Page `_ +* `EVAL-ADBMS6822 Product Page `_ +* `SDP-K1 Product Page `_ + + + +Design & Integration Files +-------------------------- + +.. ADMONITION:: Download + + `AD-CELLPACKBM-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + +:: + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/pack_monitoring.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/pack_monitoring.png new file mode 100644 index 00000000..c9d81b1b --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/pack_monitoring.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5bda9e69b50a0403ee965b0c1a85dcde3478e48b3137e93a37617f72b2a252a +size 261940 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/quick_start_guide.pdf b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/quick_start_guide.pdf new file mode 100644 index 00000000..635965bd Binary files /dev/null and b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/quick_start_guide.pdf differ diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/index.rst b/docs/solutions/reference-designs/ad-cellpackbm-sl/index.rst new file mode 100644 index 00000000..9d3e3e55 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/index.rst @@ -0,0 +1,262 @@ + +AD-CELLPACKBM-SL +################## + +Overview +--------- + +.. ADMONITION:: Download + + `AD-CELLPACKBM-SL QuickStart Guide `_ + + + +The AD-CELLPACKBM-SL is a complete BMS kit consisting of the EVAL-ADBMS6830BMSW 16-channel cell monitoring module, the EVAL-ADBMS2950-BASIC pack monitoring module, EVAL-ADBMS6822 isoSPI adapter, and the SDP-K1 microcontroller board. + +This solution is based on high-performance BMS devices that are specifically designed for broad market applications and is suitable for determining the battery's state of charge (SoC) and state of health (SoH), as well as performing important BMS diagnostics. + +The AD-CELLPACKBM-SL can operate either in embedded mode or through a PC-based graphical user interface. Complete with working software and hardware, as well as software examples, this kit makes it easier for customers to prototype and create connected systems and solutions for BMS applications. + +.. image:: ad-cellpackbm-sl.jpg + :alt: AD-CELLPACKBM-SL Kit + :align: center + :width: 600px + +Features +-------- +* Accurate voltage and current measurement +* Highly scalable and ease of integration +* Robust isoSPI capability implementable in daisy chain high count +* Inclusive passive balancing with individual pulse-width modulation +* Isolated power supply between microcontroller and battery monitoring ICs + +Applications +----------- + +* IoT Battery Management +* Industrial Machine Vision +* Power Tools +* Mobile Robotics Battery Management +* Industrial Equipment Battery Monitoring +* Adaptive Battery Type System Monitoring +* Portable Energy Storage Systems +* Electric Two-Wheelers (E2W such as E-scooter, E-bikes) +* Light Electric Vehicles + +System Architecture +------------------- +.. image:: system_architecture.png + :alt: System Architecture Diagram + :align: center + :width: 600px + +Specifications +-------------- + +Below are the absolute maximum ratings of voltages relative to GND unless noted otherwise. + +.. list-table:: + :header-rows: 1 + :widths: 25 5 5 5 5 + + + * - **Parameter** + - **Minimum** + - **Typical** + - **Maximum** + - **Unit** + * - **System Vin+ Supply Voltage** + - 6 + - 12 + - 60 + - V + * - **Cell Monitoring Main Supply Voltage** + - 11 + - + - 85 + - V + * - **VREG Supply Voltage** + - 4.5 + - 5 + - 5.5 + - V + * - **VREF1 1st Reference** + - 3.0 + - 3.2 + - 3.3 + - V + * - **Voltage No Load** + - + - + - + - + * - **VREF2 2nd Reference** + - 2.995 + - 3 + - 24 + - V + * - **Voltage, 5k Load to V-** + - + - + - + - + * - **CPIN Input Range** + - -2.5 + - + - 5.5 + - V + * - **Cell Count** + - + - + - 16 + - + * - **Pack Monitoring Main Supply Voltage In** + - 21 + - + - + - V + * - **Pack Monitoring Main Supply Voltage Out** + - + - + - 1000 + - V + * - **VREG Pack Monitor** + - 4.5 + - 5 + - 5.5 + - V + * - **Current Input S1A, I1A, I1B** + - -4 + - + - 4 + - V + * - **Current Input S2A, I2A, I2B** + - -4 + - + - 4 + - V + * - **Current Input I3A, I3B** + - -4 + - + - 4 + - V + * - **MCU Supply Voltage** + - 3.3 + - + - 5.5 + - V + * - **MCU Standalone Supply Range** + - 5 + - + - 5.5 + - V + * - **MCU via USB Supply range** + - 3.3 + - + - 5.5 + - V + * - **Cx Voltage** + - -0.3 + - + - 85 + - V + + +What's Inside the Box? +----------------------- + +Upon purchase of the AD-CELLPACKBM-SL kit, the package comes with the following boards and accessories + +.. image:: package_contents.png + :alt: Package Contents + :align: center + :width: 600px + + +Key Components +-------------- + + +**EVAL-ADBMS6830BMSW 16-Channel Battery Cell Monitor** + +The EVAL-ADBMS6830BMSW is a full-featured evaluation board for the ADBMS6830B, a 16-channel battery stack monitor for broad market applications. This board allows multiple boards to be linked through a single twisted pair wire interface (isoSPI) to monitor a long series of cells in a stack. It provides access to full channel monitoring to all cells going to battery pack either in the supply line or in the V+ to V- line. The evaluation board also features reversible isoSPI that can access either path to do measurement functions and serve as a redundant communication path. + +`Click here to see the EVAL-ADBMS6830BMSW User Guide `_ + + + +**EVAL-ADBMS2950-BASIC Battery Pack Monitor** + +The EVAL-ADBMS2950-BASIC battery pack monitoring evaluation board features the ADBMS2950B, a bidirectional current monitor, with 12 buffered high impedance voltage sense inputs, linked through a 2-wire isolated serial interface (isoSPI). This board also features reversible isoSPI, enabling a redundant communication path. + +The EVAL-ADBMS2950-BASIC board can be operated on the same isoSPI daisy-chain with other ADBMS2950B and ADBMS6830B devices. + +`Click here to see the EVAL-ADBMS2950-BASIC User Guide `_ + + + +**EVAL-ADBMS6822 Dual isoSPI Adapter** + +The EVAL-ADBMS6822 is a dual SPI to 2-wire isolated serial port interface (isoSPI) adapter featuring the ADBMS6822. This board allows multiple ADBMS68xx battery monitors through daisy-chain connections. The EVAL-ADBMS6822 evaluation board also features reversible isoSPI, which enables a redundant path to the peripheral units. The PCB components and DuraClik connectors are optimized for low electromagnetic interference (EMI) susceptibility and emissions. + +`Click here to see the EVAL-ADBMS6822 User Guide `_ + + + +**EVAL-SDP-CK1Z (SDP-K1) Controller Board** + +The EVAL-SDP-CK1Z Controller Board provides a means of communicating with the PC from the other BMS boards in the Cellpack BMS System. The SDP-K1 provides USB connectivity through a USB 2.0 high speed connection to the computer, allowing users to evaluate components on this platform from a PC application. The SDP-K1 is based on an STM32F469NIH6 Arm® Cortex®-M4 microcontroller with the peripheral communication lines available to the daughter board(s) through a 120-pin small footprint connector and Arduino® Uno-compatible headers. + +`Click here to see the SDP-K1 User Guide `_ + + + +---- + +Resources +--------- + +* `AD-CELLPACKBM-SL Product Page `_ +* `EVAL-ADBMS6830BMSW Product Page `_ +* `EVAL-ADBMS6822 Product Page `_ +* `SDP-K1 Product Page `_ + + + +Design & Integration Files +-------------------------- + +.. ADMONITION:: Download + + `AD-CELLPACKBM-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + +:: + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + + + +---------------------------------------------------------------------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :caption: Hardware Guide + + hardware_guide/index + +.. toctree:: + :maxdepth: 2 + :caption: Software Guide + + software_guide/index + diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/package.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/package.png new file mode 100644 index 00000000..01a338b7 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/package.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f3a32381541ae395a1a506c5bb849b36feab497f00f7eef426d31a97b4fc5137 +size 8399925 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/package_contents.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/package_contents.png new file mode 100644 index 00000000..542d545d --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/package_contents.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:de9603e3d7bd828ab601e5d8eb2b82d71f08bc20da41e1813f37901364be9ba1 +size 477635 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/quick_start_guide.pdf b/docs/solutions/reference-designs/ad-cellpackbm-sl/quick_start_guide.pdf new file mode 100644 index 00000000..635965bd Binary files /dev/null and b/docs/solutions/reference-designs/ad-cellpackbm-sl/quick_start_guide.pdf differ diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/data_recall.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/data_recall.png new file mode 100644 index 00000000..556d7271 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/data_recall.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:250e754453579bcf44022716819fbab37dbc7040682aeaa25ac5759264230e32 +size 193631 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/diagnostics.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/diagnostics.png new file mode 100644 index 00000000..9e6aa3b8 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/diagnostics.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2fc11e03a26ee15b331d8d09ac02b9a0bc175dc2dfe05014f673c72607620c39 +size 357835 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/downloading_drivers.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/downloading_drivers.png new file mode 100644 index 00000000..f85d89bb --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/downloading_drivers.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18f40d99fe32f50a0826445ba8b5dbb9a2e29b311238a53c2be716ee77285ccf +size 86446 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_folder.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_folder.png new file mode 100644 index 00000000..99ae94ca --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_folder.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6646857da7cfa950d874c0e22f78b58c4c2132b87775ab26c6eed16206b6330e +size 61576 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_installation_guide.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_installation_guide.png new file mode 100644 index 00000000..f3b9615c --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/examples_installation_guide.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a50f2db7ea82ddbf2d67709173f17825cba1be58b5bfc8fba226944ad26a279 +size 71359 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/index.rst b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/index.rst new file mode 100644 index 00000000..0a2aa9dc --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/index.rst @@ -0,0 +1,498 @@ +.. _ad-cellpackbm-sl software_guide: + + +Software User Guide +#################### + + +AD-CELLPACKBM-SL +================= + +This software guide provides the essential steps for firmware installation, launching the GUI, configuring the launcher, establishing interface connections, and utilizing various tabs for effective device evaluation. This covers tasks such as daisy chain configuration, quick measurements, custom command sequences, scheduling, memory mapping, plotting, data recall, diagnostics, and EIS measurements. + + +Prerequisite +--------------- + +The AD-CELLPACKBM-SL Kit can use the available no-OS BMS embedded drivers as well as the Broadmarket BMS GUI for monitoring of crucial BMS parameters. + +**MyAnalog.com account is required to download the BMS software resources.** + +Follow the steps below to create a MyAnalog account: + +1. Go to `MyAnalog `_ and create an account using email. Select the **Register with email** option to get started. +2. Once you have a MyAnalog account, log in to MyAnalog using your credentials. + + +Request for BMS Embedded Drivers +--------------------------------- + + +This reference design comes with no-OS BMS Embedded Drivers designed to run BMS measurements using a serial terminal. + +The example projects feature the ADI Broad Market BMS boards such as the EVAL-ADBMS6830BMSW cell monitor and EVAL-ADBMS2950-BASIC pack monitor, the AD-APARD32690-SL as the microcontroller, and the DC2472A battery emulator for cell voltage input. + +.. tip:: **The BMS Embedded Drivers Installer is available upon request.** + + + To request for access, send the following details to this email address: + + ✉ **BM_BMSSoftwareSupport@analog.com** + + * Email address used for MyAnalog account creation + * Company/School + * Country + * Purpose/Name of Project + + You will receive an email confirmation that you have been granted access to the BMS Embedded Installer Package. Follow the steps below to download and properly install the file to your host PC. + + + +Downloading the BMS Embedded Drivers Installer +-------------------------------------------------- + + +1. Click this link: `BMS Embedded Drivers Version 1.0.0 `__ +2. You will be directed to the *Software Package Download* page. + + * Tick the checkbox. + * The, click the **I Accept** button to indicate acceptance of the license agreement. + + .. image:: downloading_drivers.png + + +3. Click the **Download** button to download the installer package. + + +When software updates or new versions of the software are available an email notification will be sent to the email address associated with the MyAnalog account used to download the original software package. + + + +Installing the BMS Embedded Drivers +------------------------------------ + +1. Install the **no-OS-BMS-Examples-Rel1.0.0.exe** file. + + .. IMPORTANT:: Change the SPACE character with a dash (-) on the folder name or installation directory. + + =============================================================== ===================================================== + Change To + =============================================================== ===================================================== + C:\Analog Devices C:\Analog-Devices + C:\Analog Devices\no-OS-BMS-Examples-Rel1.0.0 C:\Analog-Devices\no-OS-BMS-Examples-Rel1.0.0 + =============================================================== ===================================================== + =============================================================== ===================================================== + + + .. image:: installing_the_no-os_bms_drivers.png + + + +2. Download and install `MaximSDK for Maxim MCUs `_. + + .. note:: Make sure that the location has NO WHITESPACES! For example, a typical installation location for the Maxim SDK could be **C:/MaximSDK** (Windows file location notation) + + + +3. While MaximSDK installation is in progress, set up the no-OS-BMS-Examples by going to the no-OS-BMS-Examples directory: + + * Examples Directory: C:\Analog Devices\no-OS-BMS-Examples-Rel1.0.0 + + + +4. Select the **run_setup.bat file** and run it as administrator. + + .. note:: This process will take a few minutes. Please ensure you have a stable internet connection. + + + +5. During this process, the Git Bash application will pop up (running as admin). + + +6. Wait for the setup to complete. + + * A message "**Set-up completed! with no error message**" will be displayed on the command line if the setup is successful. + * Press **ANY KEY** to close the command prompt. + + +7. Double check if the MaximSDK is successfully installed. + + * Click the **Finish** button once installation is complete. + + +8. Open the no-OS-BMS-Examples file on VS Code or any other code editor. + + * Examples Directory: C:\Analog Devices\no-OS-BMS-Examples-Rel1.0.0 + + +9. Open the Makefile inside C:\Analog Devices\no-OS-BMS-Examples-Rel1.0.0\examples folder. + + * This will display all the available example projects on the code editor. + + .. image:: examples_folder.png + + +10. Configure the Makefile on your desired example project. + + +The complete procedure on how to use the no-OS BMS examples can be found in the guide inside the **Documents** folder: + +File Location: **C:\Analog Devices\no-OS-BMS-Examples-Rel1.0.0\Documents** + + + .. image:: examples_installation_guide.png + + + + +Graphical User Interface +--------------------------- + +Downloading the GUI Installer +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. ADMONITION:: Download + + **Evaluation GUI for ADI Broad Market BMS products:** + + `BMS Browser GUI Version 2.0.0 `_ + + When software updates or new versions of the software are available an email notification will be sent to the email address associated with the MyAnalog account used to download the original software package. + + + +Launching the GUI +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To launch the GUI, navigate to the BMS_BROWSER_GUI_BroadMarket_V2.0.0 directory. + +Double-click the **BMS_BROWSER_GUI_BroadMarket_V2.0.0.exe** file. + + +Launcher Configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1. Use the launcher page to configure a daisy chain of ADBMS devices. +2. Select an appropriately flashed microcontroller board (for this example, SDP-K1). +3. Launch the evaluation GUI. + + .. image:: install_gui.png + + +Establishing Interface Connection +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +1. The `Interface Connection`` section displays available SDP-K1 devices on the left. +2. Left-side selection determines the device for launching the evaluation GUI with the `Launch Button`. +3. If the GUI is open, the connected COM port appears on the right. +4. Click `Disconnect`` to terminate the connection for a new one. +5. Use the refresh button to reload the available MCU boards list. + +.. image:: interface_connection.png + + + +Daisy Chain Connection +^^^^^^^^^^^^^^^^^^^^^^^ + +The Daisy Chain section facilitates the creation of a daisy chain using compatible ADBMS devices. This process involves selecting a generation of ADBMS devices, adding devices to the daisy chain, and configuring the setup for the evaluation GUI. + +.. image:: daisy_chain_connection.png + + +**Select ADBMS Generation** + +1. Navigate to the Daisy Chain section. +2. Use the first option to choose a specific generation of ADBMS devices. + +.. note:: Devices within a selected generation are compatible and can be used together in the evaluation GUI. + + +**Add Devices to the Daisy Chain:** + +1. After selecting the generation, locate the available devices list. +2. Choose a device for the daisy chain. +3. Press the right chevron button to append the selected device to the daisy chain. +4. This added device becomes the next farthest in the daisy chain. + +**Remove Devices from the Daisy Chain:** + +1. To remove a device, go to the daisy chain table. +2. Select the device you want to remove. +3. Press the trash can button to delete the selected device from the daisy chain. + +**Configure Daisy Chain for GUI Launch:** + +1. In the Interface Connection section, select the desired MCU board. +2. Configure the daisy chain in the Daisy Chain section. +3. Click on the launch button to initiate the evaluation GUI. + + + +GUI Tabs +-------- + +Quick Measure +^^^^^^^^^^^^^^ + +The Quick Measure tab simplifies metric measurement with a preloaded command sequence. Note that it supports a single device in the daisy chain, and key features enhance configuration and visualization. + + .. image:: quick_measure.png + + + + **Preloaded Commands:** + + - Access the Quick Measure tab for easy metric measurement with a preloaded command sequence. + + **Daisy Chain Limitation:** + + - Note: Quick Measure tab supports only a single device in the daisy chain, configured for the last device. + + **Quick Configuration:** + + - Utilize the lower-left section for swift changes to commonly modified bitfields. + + **Numeric Data Display:** + + - In the lower-right section, view numeric data returned from devices. + - Control plotted data on the central plot using checkboxes. + + **Central Plot Visualization:** + + - The central plot provides a graphical representation of captured data. + - X-axis: Sample number; + - Y-axis: Metric-specific variation. + + **Measurement Loop Control:** + + - Initiate and terminate the measurement loop with the top button. + - The button turns yellow during loop activation and green when deactivated. + + + +Sequences +^^^^^^^^^^^^^ + +The Sequences tab enables the creation and management of custom command sequences. Load and save sequences, divided into Init and Loop lists. The Init list initializes the daisy chain once, while the Loop list runs continuously until stopped. Toggle between lists using the corresponding buttons at the top. + + .. image:: sequences.png + + + **Load Existing Sequence:** + + - Use the Existing Sequence Files select bar to choose an existing sequence file. + - Select the desired sequence from the Existing Sequences select bar. + + **Save Sequence:** + + - In the New Sequence File text area, enter the name for the new sequence file. + - Specify the sequence name in the New Sequence Name text area. + - Press the save button to save the sequence. + + **Load Defaults:** + + - Load the default command list for the Quick Measure tab by pressing the Load Defaults button. + - All sequence files are saved in the installation location under the data/sequence directory. + + **Add Command:** + + - On the left side of the screen, use the select boxes and buttons to add a command to the selected command list. + - Select a command from the Commands select box to load available bitfields on the bottom left. + - Modify bitfields as needed and press Add to add the command to the list on the right side. + + **Manage Commands:** + + - On the right side, select a command to highlight it for modification. + - Replace, move (drag and drop), or delete the highlighted command using the corresponding buttons. + + **SPI Bus and Chip Select:** + + - Under the Command select bar, use the SPI Bus and SPI CS Select bars to change the SDP-K1 SPI bus and chip select for the command. + + **Optional Map Key:** + + - Below the SPI Bus and SPI CS Select bars, use the optional Map Key field to apply a label to the command. + - Labels organize output data, grouping commands with the same label together for focused data analysis. + + + +Scheduler +^^^^^^^^^^ + +The Scheduler tab provides insights into the execution time of sequences from the Sequences tab. It allows combining sequences for a complete execution loop. Key features enable precise timing adjustments and visualization. + + .. image:: scheduler.png + + + **Timing Adjustments:** + + - Utilize the SPI Clock field to adjust timings based on the system SPI clock frequency (kHz). + - The MCU Command to Command Overhead field adjusts timing between commands to accommodate MCU transaction timings. + - The FDTI field represents the total loop time, used for margin calculations. + + **Initialization and Sequence Management:** + + - Choose the Initialization field to pick the sequence for daisy chain initialization. + - The Available Cycle Sequences list displays all available sequences for scheduling. + - Use the Add button to add selected cycles to the schedule. + + **Hardware Timers and Timing Verification:** + + - Add hardware timers to cycle sequences with the Add Cycle Timers field for timing verification in freerun mode. + + **Schedule Management:** + + - Remove and Clear buttons allow removal of cycles from the schedule. + - Drag and drop cycles to rearrange them within the schedule. + + **Schedule Overview:** + + - The schedule table displays added cycles, their execution time, and margin for the selected daisychain. + - The plot at the bottom visually represents the same information in a waterfall format. + + **Transfer for Real Hardware Timing:** + + - Use the Transfer button to move all cycles into a single sequence in the Sequences tab. + - Run the transferred sequence to assess real hardware timing. + + +Memory Map +^^^^^^^^^^^ + +The Memory Map tab provides a numerical output for the active command loop, organized into tables for user convenience. It offers customization and error highlighting for effective data analysis. + + .. image:: memory_map.png + + + **Organized Data Display:** + + - Access the Memory Map tab for a numerical output of the currently running command loop. + - Multiple tables organize the data into useful groups. + + **Table Management:** + + - Each table can be minimized for a more streamlined view. + + **Default View and Map Key Selection:** + + - The default view presents all data from the command list. + - Use the Map Key select bar to switch to a specific group of data for focused analysis. + + **Device-specific Data:** + + - Tables contain data returned by all devices in the daisy chain. + + **Error Highlighting:** + + - Rows highlight in orange if data returned with a PEC error. + - Valid data does not have any highlighting for easy differentiation. + + + +Plots +^^^^^^^ + +The Plots tab provides a graphical representation of data collected through the running command loop. It offers customization options for focused analysis and allows for the export of captured data for further analysis. + + .. image:: plots.png + + + **Plot Selection:** + + - Use the Plot Selection area at the top to control the central Plot. + - Checkboxes in the Plot Filter area at the bottom filter data for the Plot. + + **Metric Plotting:** + + - Check the Plot Filter checkboxes for desired metrics and device numbers. + - Additional checkboxes allow for plotting all devices for a metric, all metrics for a device, or all metrics for all devices. + + **Save and Load Filter Setups:** + + - Save a filter setup for future use by providing a name in the Save Plot Filter text box and clicking Save. + - Load existing filter setups using the Load Plot Filter select. + + **Map Key Group Selection:** + + - Narrow data to a specific map key group using the Map Key select in the Plot Selection area. + + **Plot Options:** + + - Choose between line chart and histogram using the Plot Selection Type select. + + **Export Data:** + + - Click the Export Data button to export captured data as a CSV file for further analysis. + - Data is exported to the data directory, grouped by map key. + + + +Data Recall +^^^^^^^^^^^^^ + + .. image:: data_recall.png + + + +The Data Recall tab allows you to retrieve and plot data from previous freerun sessions stored in a database file. The interface is similar to the Plots tab with added functionality for selecting the database file and test run. + + **Access Data Recall Tab:** + + - Navigate to the Data Recall tab for recalling and plotting data from previous freerun sessions. + + **Database File Selection:** + + - Click on the select box under the Database Names label. + - Choose the desired database file; the default is data.db. + + **Test Run Selection:** + + - Click on the select box under the Test Run IDs label. + - Pick the specific test run from the list, arranged chronologically and UTC timestamped. + + **Load Test Run:** + + - Click the Load Test Run button to recall data from the selected database file and test run. + + **Customize Plot:** + + - After loading the test run, customize the plot using the same methods as the Plots tab. + + + +Diagnostics +^^^^^^^^^^^^^ + + .. image:: diagnostics.png + + +The Diagnostics tab offers a straightforward way to execute on-device diagnostics following the device's safety manual. It displays available diagnostics, test logs, and results for a single device. + + **Access Diagnostics Tab:** + + - Navigate to the Diagnostics tab for on-device diagnostics execution. + + **Device Selection:** + + - Use the Device Selection bar to switch between devices. + + **Run Diagnostics:** + + - In the Functions section on the left, click on the button with the name of the desired diagnostic. + - The diagnostic runs, and results are displayed on the right side: highlighted green for pass and red for failure. + + **Diagnostic Log:** + + - A log of diagnostic-specific data appears in the center of the screen. + - The log provides context for understanding why a diagnostic may have failed. + + + +Help and Support +----------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + + diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/install_gui.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/install_gui.png new file mode 100644 index 00000000..bf94f261 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/install_gui.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d0125c4683f31dcf7db4446a29ddf805fdf59b5224640bba72e293784edd338f +size 88325 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/installing_the_no-os_bms_drivers.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/installing_the_no-os_bms_drivers.png new file mode 100644 index 00000000..b4fed13f --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/installing_the_no-os_bms_drivers.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:192a3e5a1bc7c975a0cc0da2fd93652a7570b7efac950b6ab1ca45dde60ed6c6 +size 86355 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/interface_connection.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/interface_connection.png new file mode 100644 index 00000000..ca8b5dad --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/interface_connection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1483cff5512ed01486cd0a8b6d8e5312efce2ea2ef1e99a177b1271a462faa1e +size 30586 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/memory_map.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/memory_map.png new file mode 100644 index 00000000..8a06b817 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/memory_map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa1ca995dadff28bed1055eede4cf94923655aa5322c3863e6733fd188fa8014 +size 331373 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/plots.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/plots.png new file mode 100644 index 00000000..36474736 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/plots.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8b77ac052659fdd3cf73f51761e58d1ce1ce7bdc8850322022607654560aa61e +size 244978 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/quick_measure.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/quick_measure.png new file mode 100644 index 00000000..7f0988a0 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/quick_measure.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d634451fb0be96f14df3754d75d921eaf287e61e7f67455a3def2b9cbb3a74c +size 374402 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/scheduler.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/scheduler.png new file mode 100644 index 00000000..c0edf483 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/scheduler.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:70e44b3db63e89360d61192caf8cf2e830bd0fdab78bff967c6bc5e943e38a9e +size 120074 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/sequences.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/sequences.png new file mode 100644 index 00000000..a33a506f --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/sequences.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:41d4cc1ceddc96edf3caa29475ce935b3193f9cfefebec684038d6dae58d0ff2 +size 214093 diff --git a/docs/solutions/reference-designs/ad-cellpackbm-sl/system_architecture.png b/docs/solutions/reference-designs/ad-cellpackbm-sl/system_architecture.png new file mode 100644 index 00000000..1cb572f9 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/system_architecture.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79dff853e3bd7e69768c1dc51a012bf7a0b21ad08c3940aba8a34d880fdbf0ea +size 70400 diff --git a/docs/solutions/reference-designs/index.rst b/docs/solutions/reference-designs/index.rst new file mode 100644 index 00000000..1a4758c1 --- /dev/null +++ b/docs/solutions/reference-designs/index.rst @@ -0,0 +1,37 @@ +Reference Designs +============================= + +.. toctree:: + :maxdepth: 2 + + ad-cellpackbm-sl/index + + + .. toctree:: + :caption: Hardware Guide + + ad-cellpackbm-sl/hardware_guide/index + + + .. toctree:: + :caption: Software Guide + + ad-cellpackbm-sl/software_guide/index + + +.. toctree:: + :maxdepth: 2 + + ad-bmse2e3w-sl/index + + .. toctree:: + :caption: Software Guide + + ad-bmse2e3w-sl/software_guide/index + + .. toctree:: + :caption: Sample Application + + ad-bmse2e3w-sl/sample_application/index + + diff --git a/docs/sources/custom.css b/docs/sources/custom.css old mode 100755 new mode 100644 diff --git a/docs/sources/icon.svg b/docs/sources/icon.svg old mode 100755 new mode 100644