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..f3095fbc --- /dev/null +++ b/docs/solutions/application-software/index.rst @@ -0,0 +1,13 @@ +Application Software +------------------------ + + +.. 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-apard32690-sl/02-073637-01-c.pdf b/docs/solutions/reference-designs/ad-apard32690-sl/02-073637-01-c.pdf new file mode 100644 index 00000000..c402492c Binary files /dev/null and b/docs/solutions/reference-designs/ad-apard32690-sl/02-073637-01-c.pdf differ diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/05-073637-01-c.zip b/docs/solutions/reference-designs/ad-apard32690-sl/05-073637-01-c.zip new file mode 100644 index 00000000..44842894 Binary files /dev/null and b/docs/solutions/reference-designs/ad-apard32690-sl/05-073637-01-c.zip differ diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/08_073637c.zip b/docs/solutions/reference-designs/ad-apard32690-sl/08_073637c.zip new file mode 100644 index 00000000..ebb2c4be Binary files /dev/null and b/docs/solutions/reference-designs/ad-apard32690-sl/08_073637c.zip differ diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/ad-apard32690-sl-fbl.png b/docs/solutions/reference-designs/ad-apard32690-sl/ad-apard32690-sl-fbl.png new file mode 100644 index 00000000..e4315eac --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/ad-apard32690-sl-fbl.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:69f4fd770a1c0fab77b9a5092abf705a11ddb7af7155cfc67f89550083670e5f +size 68138 diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/eval-max32690-ardz_angle.jpg b/docs/solutions/reference-designs/ad-apard32690-sl/eval-max32690-ardz_angle.jpg new file mode 100644 index 00000000..db63a261 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/eval-max32690-ardz_angle.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1670c8e9721b60b28ec785b6b37eb293f5364bd94748987199e1e57b70b585e9 +size 114489 diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_hw_components.png b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_hw_components.png new file mode 100644 index 00000000..c5be1cfc --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_hw_components.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47a0eebc907a837d31685725b29207972e58290abcae03ff6376c32277dd6085 +size 484721 diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_system_setup.jpg b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_system_setup.jpg new file mode 100644 index 00000000..2a727d5a --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/apard32690_system_setup.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01dbe4a7f0a6460731935963cbcbaab56a1c815752d27bce15e7791501038681 +size 66499 diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/index.rst b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/index.rst new file mode 100644 index 00000000..89338f66 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/index.rst @@ -0,0 +1,103 @@ + +Hardware & Software Guide +============================ + + +Required Hardware +----------------- + +- **Development kit**: :adi:`AD-APARD32690-SL Microcontroller Board ` +- **Power supplies**: 5V to 28V at 2A external power supply or 5V USB-C power supply +- **Programmer**: :adi:`MAX32625PICO` or any other similar programmer supporting the SWD interface + + +AD-APARD32690-SL Board Description +---------------------------------- + +.. image:: apard32690_hw_components.png + +.. csv-table:: Pin Descriptions + :file: pin-descriptions.csv + + +System Setup +------------ + +- Connect the AD-APARD32690-SL to the :dokuwiki:`AD-T1LUSB2.0-EBZ ` using the single pair Ethernet cable. +- Connect the AD-T1LUSB2.0-EBZ to your PC using an USB cable. +- Connect the MAX32625PICO programmer, or any programmer supporting the SWD interface, to the AD-APARD32690-SL. +- Connect the power supply to the AD-APARD32690-SL. + +.. image:: apard32690_system_setup.jpg + :width: 600 px + +-------------- + +Updating the AD-APARD32690-SL firmware +-------------------------------------- + +Setting up the MAX32625PICO +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To update the board’s firmware, a new bootloader has to be flashed on the +MAX32625PICO. + +- Download the firmware image: `MAX32625PICO firmware `__ +- Set the MAX32625PICO in MAINTENANCE mode: + * Disconnect the MAX32625PICO from the PC and the AD-SWIOT1L-SL board. + * Plug the micro USB cable only in the MAX32625PICO. + * Keep the button on the MAX32625PICO pressed. + * Plug the micro USB cable into the PC. + * Once you see the MAINTENANCE drive being mounted, you may release the button. + + .. image:: picture2.jpg + :width: 200 px + +- Drag and drop (to the MAINTENANCE drive) the firmware image you previously downloaded. +- After a few seconds, the MAINTENANCE drive will disappear and will be replaced by a drive named DAPLINK. Once this is done, the process is complete, and the MAX32625PICO may be used to flash the firmware of the AD-SWIOT1L-SL board. + + +Programming the AD-APARD32690-SL +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Connect the MAX32625PICO to the PC using the micro USB cable. +- Connect the MAX32625PICO to the AD-APARD32690-SL board using the 10-pin ribbon + cable. +- Connect the power supply to the AD-APARD32690-SL. Make sure the board is + powered up for the next steps. +- A DAPLINK drive should appear as mounted on your PC. +- Drag and drop the new firmware image into the DAPLINK drive. After a few + seconds, the drive will be remounted. +- Check the DAPLINK directory and make sure there is no FAIL.TXT file. In case + there is, repeat the drag and drop step. Otherwise, you may disconnect the + MAX32625PICO from the AD-APARD32690-SL, since the firmware update is complete. + + +AD-APARD32690-SL Software Stack +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The system is accompanied by an open-source software stack and associated +collateral, enabling a complete experience from evaluation and prototyping all +the way to production firmware and applications development. + +The `AD-APARD32690-SL firmware `__ +is based on Analog Devices’ open-source no-OS framework, which includes all the +tools required for embedded code development and debugging as well as libraries +enabling host-side connectivity for system configuration and data transfer over +the UART or the 10BASE-T1L interfaces. The firmware source code and related +documentation can be found on the Analog Devices GitHub at the link above. + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + +---------------------------------------------------------------------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :caption: Hardware & Software Guide + + hardware-and-software-guide/index + diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/picture2.jpg b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/picture2.jpg new file mode 100644 index 00000000..bc5116eb --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/picture2.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4325e2ccb70eabf2d263790933b79db08c90b163cc181910d9b75c744d6a4a10 +size 13561 diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/pin-descriptions.csv b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/pin-descriptions.csv new file mode 100644 index 00000000..a1a2ab27 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/hardware-and-software-guide/pin-descriptions.csv @@ -0,0 +1,39 @@ +LEDs, +DS1,Power good +DS2,User LED +Buttons & Switches, +S1,MAX32690 Reset +S2,User Button +S3,User switches +S4,1: ADIN1110 SWPD_EN +,2: ADIN1110 SPI_CFG0 +,3: ADIN1110 SPI_CFG1 +Jumper settings, +P50,Position 1-2: Connect programmer SWD_RX to WiFi UART TX +,Position 2-3: Connect programmer SWD_RX to MAX32690 +P55,Position 1-2: Connect programmer SWD_TX to WiFi UART RX +,Position 2-3: Connect programmer SWD_RX to MAX32690 +P38,Connect WiFi UART TX to MAX32690 +P56,Connect WiFi UART RX to MAX32690 +P51,Position 1-2: Set programmer voltage to 3V3 (normal operation mode) +,Position 2-3: Set programmer voltage to 1V8 (WiFi chip programming) +Connectors, +P1,10BASE-T1L +P10,USB-C Power & Data +P14,External Power 5V-28V +P9,SWD Programmer +P11,SPOE Shield ISO GND +P16,SPOE Shield PI+ +P17,SPOE Shield PI- +P53,SPOE Shield PI+ +P54,SPOE Shield PI- +P12,SPOE Shield Data TRX N +P15,SPOE Shield Data TRX P +P8,SPI PMOD +P13,I2C PMOD +P2,Arduino Connector - Power +P3,Arduino Connector - Analog +P4,Arduino Connector - SPI / I2S +P5,Arduino Connector - SPI & I2C +P6,Arduino Connector - UART +P7,Arduino Connector - GPIO & CAN diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/index.rst b/docs/solutions/reference-designs/ad-apard32690-sl/index.rst new file mode 100644 index 00000000..4eb1b854 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/index.rst @@ -0,0 +1,90 @@ + +AD-APARD32690-SL +================== + +Introduction +------------ + +The :adi:`AD-APARD32690-SL ` is an Arduino Form-factor +Development Platform based on :adi:`MAX32690 ` ARM Cortex-M4 +Microcontroller, targeted for prototyping intelligent, secure, and connected +industrial field devices. Some of the main features and benefits include: + +- Arduino Mega-compatible form factor +- Two Pmod™-compatible connectors +- ARM Cortex-M4 Ultra Efficient Microcontroller with integrated Bluetooth 5.2 LE +- WiFi connectivity +- Long-range, single-pair 10BASE-T1L Ethernet interface +- Built-in security for root-of-trust, mutual authentication, data confidentiality and integrity, secure boot, and secure communications +- Open-source software stack + + .. image:: eval-max32690-ardz_angle.jpg + :width: 450 px + :align: left + + .. image:: ad-apard32690-sl-fbl.png + :width: 450 px + :align: right + + +.. csv-table:: Specifications + :file: specifications.csv + + + +**Hardware design files:** + +- `Schematics <02-073637-01-c.pdf>`_ +- `Layout <08_073637c.zip>`_ +- `Bill of Materials <05-073637-01-c.zip>`_ + + + +System Setup & Evaluation +------------------------- + +The development kit is delivered with a set of accessories required to put the +system together and get it up and running in no time. + +This is what you’ll find in the development kit box: + +- 1 x AD-APARD32690-SL board +- 1 x :dokuwiki:`AD-T1LUSB2.0-EBZ ` 10BASE-T1L to USB adapter board +- 1 x PROFIBUS (1x2x18AWG) cable for Single Pair Ethernet (SPE) connectivity +- 1 x USB 2.0 cable + +:dokuwiki:`Getting the system up and running ` + + + +Application Development +----------------------- + +.. image:: sw_block_diagram.png + :width: 400 px + +The :adi:`AD-APARD32690-SL ` firmware is based on ADI’s +open-source no-OS framework. It includes the bare-metal device drivers for all +the components in the system as well as example applications enabling +connectivity via the 10BASE-T1L interface for system configuration and data +transfer. + +`AD-APARD32690-SL Firmware Source Code and User Guide `_ + + + +Help and Support +---------------- + +For questions and more information, please visit the `EngineerZone Support Community `_. + + +Up Next: Hardware & Software User Guide +---------------------------------------- + +.. toctree:: + :titlesonly: + :glob: + + */index + diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/specifications.csv b/docs/solutions/reference-designs/ad-apard32690-sl/specifications.csv new file mode 100644 index 00000000..2a555232 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/specifications.csv @@ -0,0 +1,13 @@ +Computing Resources, +CPU,MAX32690 Ultralow Power ARM Cortex-M4 with FPU-Based Microcontroller (MCU) with 3 MB Flash and 1 MB SRAM +Memory,1 Gb RAM +Storage,64 Mb QSPI Flash +Security,MAXQ1065 Ultralow Power Cryptographic Controller with ChipDNATM +Connectivity, +Ethernet,"ADIN1110 Robust, Industrial, Low Power 10BASE-T1L Ethernet MAC-PHY" +WiFi,"NINA-W102 - IEEE 802.11b, IEEE 802.11g, IEEE 802.11n" +Bluetooth,Bluetooth 5.2 LE Radio +USB,USB 2.0 +Power supply, +External power,5V DC to 28V DC +USB-C,"5 V at 3 A, without power negotiation" diff --git a/docs/solutions/reference-designs/ad-apard32690-sl/sw_block_diagram.png b/docs/solutions/reference-designs/ad-apard32690-sl/sw_block_diagram.png new file mode 100644 index 00000000..f7bacfa1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-apard32690-sl/sw_block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:869c2524a94f2a4cb83a83edbcc8850540da50a335079c325e72b124dfcb1375 +size 119657 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..0f5b91bc --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/index.rst @@ -0,0 +1,229 @@ +AD-BMSE2E3W-SL +============== + +A concise version of this document is available in portable document format. +Click on the file below to download: + +.. admonition:: Download + + :download:`AD-BMSE2E3W-SL QuickStart Guide (pdf) ` + +Overview +-------- + +.. image:: ad-bmse2e3w-sl_angle.jpg + :align: left + +The :adi:`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. + + +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 + +.. 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. + + +.. esd-warning:: + +.. 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: + +#. Download the firmware image: + :downgit-max32625pico-firmware-images:`MAX32625PICO Firmware Image for MAX32690 ` + +#. Do not connect the MAX32625PICO to the AD-BMSE2E3W-SL Board yet. + +#. Connect the MAX32625PICO to the Host PC using the micro USB to USB cable. + +#. Press the button on the MAX32625PICO. (Do not release the button until the MAINTENANCE drive is mounted) + +#. Release the button once the MAINTENANCE drive is mounted. + +#. Drag and drop (to the MAINTENANCE drive) the firmware image. + +#. 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: + +#. 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 + +#. 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 + +#. Set the DC2472A battery emulators to the lowest voltage by fully turning the Cell Voltage Adjustment Potentiometer counterclockwise. + +#. 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 + +#. 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 + +#. 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 + +#. Set the DC2472A battery emulators to HIGH voltage or equivalent to 4.1 V per cell by turning the Cell Voltage Adjustment Potentiometer clockwise. + +#. 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 + +#. 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 +++++++++++++ + +- :adi:`ADBMS6830` +- :adi:`ADBMS2950` +- :adi:`ADBMS6822` +- :adi:`MAX32690` +- :adi:`LLT8303` +- :adi:`ADUM225N` +- :adi:`LTC7001` +- :adi:`LTC3639` + +Design & Integration Files +++++++++++++++++++++++++++ + +.. admonition:: Download + + `AD-BMSE2E3W-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + +Guides&Sample Software +---------------------- + +A software user-guide and sample application for :adi:`AD-BMSE2E3W-SL` are available: + +.. toctree:: + :titlesonly: + :glob: + + */index + +Help and Support +---------------- + +For questions and more information, please visit the :ez:`EngineerZone Support Community `. \ No newline at end of file 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..58ec0e70 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/sample_application/index.rst @@ -0,0 +1,46 @@ +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 + +#. **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: + + + .. figure:: single_side_cell_depopulation.png + + Single Side Cell Depopulation + + .. figure:: dual_side_cell_depopulation.png + + Dual Side Cell Depopulation + + .. 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. + +#. **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). + +#. **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 + + .. figure:: basic_can_comm.png + + CAN-BASIC Communication + + .. 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. + +#. **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. \ No newline at end of file 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..978143b8 --- /dev/null +++ b/docs/solutions/reference-designs/ad-bmse2e3w-sl/software_guide/index.rst @@ -0,0 +1,149 @@ +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: + +#. Go to :adi:`MyAnalog ` and create an account using email. Select the **Register with email** option to get started. + +#. Once you have a MyAnalog account, log in to :adi:`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 +----------------- + +#. Download from: `AD-BMSE2E3W-SL Version 1.0.0 `_ + +#. 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. + +#. 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 +---------------- + +#. Double-click on **ad-bmse2e3w-sl-rel1.0.0.exe** to install the program to your computer. + + .. image:: gui_executable_file.png + +#. 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 + +#. 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 + + +#. Drag and drop the .hex file into the DAPLink drive to flash the program on the MCU. + + .. image:: hex_file_to_daplink.png + + +#. 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 + +#. 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 + +#. 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 + + +#. 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 + + +#. 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 \ No newline at end of file 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..66093bf5 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/hardware_guide/index.rst @@ -0,0 +1,223 @@ +.. _ad-cellpackbm-sl hardware_guide: + +Hardware User 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: + +:adi:`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 +--------- + +* :adi:`AD-CELLPACKBM-SL` +* :adi:`EVAL-ADBMS6830BMSW` +* :adi:`EVAL-ADBMS2950-BASIC` +* :adi:`EVAL-ADBMS6822` +* :adi:`SDP-K1` + +Design & Integration Files +-------------------------- + +.. admonition:: Download + + `AD-CELLPACKBM-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project \ No newline at end of file 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..cb9077d7 --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/index.rst @@ -0,0 +1,241 @@ +AD-CELLPACKBM-SL +================ + +A concise version of this document is available in portable document format. Click on the file below to download: + +.. admonition:: Download + + :download:`AD-CELLPACKBM-SL QuickStart Guide ` + +Overview +-------- + +.. figure:: ad-cellpackbm-sl.jpg + :align: left + :width: 600px + + AD-CELLPACKBM-SL Kit + +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. + +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 ++++++++++++++++++++ + +.. figure:: system_architecture.png + :align: center + :width: 600px + + System Architecture Diagram + +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 + :class: bold-header bold-first-column + + * - 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 + +.. figure:: package_contents.png + :align: center + :width: 600px + + Package Contents + +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. + +:dokuwiki:`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. + +:dokuwiki:`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. + +:adi:`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. + +:adi:`Click here to see the SDP-K1 User Guide ` + +Resources ++++++++++ + +* :adi:`AD-CELLPACKBM-SL` +* :adi:`EVAL-ADBMS6830BMSW` +* :adi:`EVAL-ADBMS2950-BASIC` +* :adi:`EVAL-ADBMS6822` +* :adi:`SDP-K1` + +Design & Integration Files +++++++++++++++++++++++++++ + +.. admonition:: Download + + `AD-CELLPACKBM-SL Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + +Guides&Sample Software +---------------------- + +.. toctree:: + :titlesonly: + :glob: + + */index + +Help and Support +---------------- + +For questions and more information, please visit the :ez:`EngineerZone Support Community `. \ No newline at end of file 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..aebeff8b --- /dev/null +++ b/docs/solutions/reference-designs/ad-cellpackbm-sl/software_guide/index.rst @@ -0,0 +1,439 @@ +.. _ad-cellpackbm-sl software_guide: + +Software User Guide +=================== + +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: + +#. Go to :adi:`MyAnalog ` and create an account using email. Select the **Register with email** option to get started. +#. 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 +---------------------------------------------- + + +#. Download from: `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 + +#. 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 +----------------------------------- + +#. 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 + +#. 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) + +#. 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 + +#. 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. + +#. During this process, the Git Bash application will pop up (running as admin). + +#. 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. + +#. Double check if the MaximSDK is successfully installed. + + * Click the **Finish** button once installation is complete. + +#. 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`` + +#. 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 + +#. 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:** + + :adi:`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 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +#. Use the launcher page to configure a daisy chain of ADBMS devices. +#. Select an appropriately flashed microcontroller board (for this example, SDP-K1). +#. Launch the evaluation GUI. + +.. image:: install_gui.png + +Establishing Interface Connection +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +#. The `Interface Connection`` section displays available SDP-K1 devices on the left. +#. Left-side selection determines the device for launching the evaluation GUI with the `Launch Button`. +#. If the GUI is open, the connected COM port appears on the right. +#. Click `Disconnect`` to terminate the connection for a new one. +#. 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:** + +#. After selecting the generation, locate the available devices list. +#. Choose a device for the daisy chain. +#. Press the right chevron button to append the selected device to the daisy chain. +#. This added device becomes the next farthest in the daisy chain. + +**Remove Devices from the Daisy Chain:** + +#. To remove a device, go to the daisy chain table. +#. Select the device you want to remove. +#. Press the trash can button to delete the selected device from the daisy chain. + +**Configure Daisy Chain for GUI Launch:** + +#. In the Interface Connection section, select the desired MCU board. +#. Configure the daisy chain in the Daisy Chain section. +#. 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. 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/ad-gmslcamrpi-adp/02_075922a_top.pdf b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/02_075922a_top.pdf new file mode 100644 index 00000000..fc569ed5 Binary files /dev/null and b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/02_075922a_top.pdf differ diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/05-075922-01-a.zip b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/05-075922-01-a.zip new file mode 100644 index 00000000..3348de6d Binary files /dev/null and b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/05-075922-01-a.zip differ diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/08_075922a.zip b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/08_075922a.zip new file mode 100644 index 00000000..ea62c8eb Binary files /dev/null and b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/08_075922a.zip differ diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/block_diagram.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/block_diagram.png new file mode 100644 index 00000000..58d71bff --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa9eba989a7d7d265d747f7d3f9cdb2331adb9151471c12b6f6f2e639d395edf +size 48713 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/index.rst b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/index.rst new file mode 100644 index 00000000..20c8f685 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/index.rst @@ -0,0 +1,146 @@ + +AD-GMSLCAMRPI-ADP# +==================== + +Seamlessly insert GMSL into the signal chain and create a full GMSL Camera +System with off the shelf parts. + +.. image:: signal_chain.png + :width: 600 px + + +Overview +-------- + +The `AD-GMSLCAMRPI-ADP# `__ +enables connecting GMSL serializer and deserialier Evaluation Kits (EVK) to a +wide range of cameras and processing platforms supporting industry standard +ribbon cable connectors. The adapter consists of three sections that can be +broken apart from each other, with the following functionalities: + +- A **Ribbon Cable Adapter** having two pairs of 15-pin and 22-pin connectors +routed to each other. The 15-pin connectors support 2 MIPI lanes, while the +22-pin connectors support 4 MIPI lanes. +- A **GMSL Serializer EVK Adapter** with two 22-pin ribbon cable connectors, for +connecting cameras to the GMSL serializers. A USB Type-A connector is +available to supply 5V @ 4A to another system +- A **GMSL Deserializer EVK Adapter** with two 22-pin ribbon cable connectors, +for connecting to Raspberry Pi, Nividia or Xilinx development platforms, or +any other processing platform supporting the 15-pin or 22-pin ribbon cable +connectors + +.. image:: block_diagram.png + :width: 600 px + +.. image:: wikigmsladptop.png + :width: 600 px + + +Specifications +-------------- + +.. csv-table:: + :file: specifications.csv + +.. Warning:: Do not use the 15-pin ribbon cable included with the Raspberry Pi camera since that is an opposite sided cable. + + +.. admonition:: Download + + **Hardware Design Files** + + - `Schematics <02_075922a_top.pdf>`_ + - `Layout <08_075922a.zip>`_ + - `High level BOM <05-075922-01-a.zip>`_ + + + + +GMSL EV Kit Compatibility +------------------------- + +The MIPI-CSI2 signals, I2C communication, and power pins align on the EV kits +but the MFP connections can vary. + +Refer to the :dokuwiki:`Serializer and Deserializer EV Kit Compatibility Guide ` to see the connections across EV kits. + + + +Camera Connections +------------------ + +Connect RPi 15-pin cameras to GMSL Serializer EV Kit’s with the 15-pin to 22-Pin +adapter. Or use a 15-pin to 22-Pin Adapter Cable. + +.. image:: wikigmslcamadpser.png + :width: 500 px + + +.. image:: wikigmsl15adp22ser.png + :width: 500 px + + + +-------------- + +SoC Connections +--------------- + +The same configuration is used for the SoC side where the 22-pin adapter can be +directly connect to a Jetson Orin Development kit or use the 22-15 pin adapter +to connect to an Raspberry Pi. + +.. image:: wikigmsladpdesjeto.png + :width: 500 px + +.. image:: wikigmsladpdesrpi4.png + :width: 500 px + + + +Example Configurations +---------------------- + +The adapter can be used to connect the GMSL Deserializer EV kits to a number of +processing platforms for GMSL evaluation and application development. The user +guides below provide instructions on how to get the systems up and running by +configuring the hardware and running the associated software. + + +- :dokuwiki:`Nvidia Jetson Orin Nano User Guide ` +- :dokuwiki:`Raspberry Pi User Guide ` +- :dokuwiki:`AMD Kria User Guide ` + + +Software Development +-------------------- + +The GMSL Linux kernel drivers, the complete Linux distributions for the +supported processing platforms, and software user guides can be found on the +`Analog Devices GMSL GitHub repository `__. + + + +Support +------- + +For questions and more information, please contact us on the **Analog Devices +Engineer Zone**. + +- :ez:`EngineerZone Linux Software Drivers ` +- :ez:`EngineerZone FPGA Reference Designs ` + + + +---------------------------------------------------------------------------------------------------------- + +Up Next... + + +.. toctree:: + :titlesonly: + :maxdepth: 1 + :glob: + + */index + diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/adaptor_block_diagram.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/adaptor_block_diagram.png new file mode 100644 index 00000000..88f145ba --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/adaptor_block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29f50b8ea849a450e27e84167bc7c20db3bb4374b8ae51b72376644dc6f6e444 +size 114991 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_interposer_cfg.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_interposer_cfg.png new file mode 100644 index 00000000..3fc13d49 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_interposer_cfg.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a21e9557c5e4ce6a71a63a4fb9d97e28b3ddeed17cbaf40360bb8fe61693d95 +size 833350 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_resistors.jpg b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_resistors.jpg new file mode 100644 index 00000000..5be37663 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/deserializer_resistors.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4e348bf97701a2683e2bb025a3e7d68e94bac8029d11a3d5f7d869780a6d6e42 +size 78137 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_deserializer_sw5.jpg b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_deserializer_sw5.jpg new file mode 100644 index 00000000..babc9a49 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_deserializer_sw5.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6ed02539ecdc56bd314a9c5d685b6a91e6134d8f148409271512a4f7cafa5d99 +size 78587 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_full_system_config.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_full_system_config.png new file mode 100644 index 00000000..424f481b --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/gmsl_full_system_config.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45f0aee70b34bacab73b95624f2510940563e8920358489b6eb3bcf33251f668 +size 271044 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/index.rst b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/index.rst new file mode 100644 index 00000000..c7f3da91 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/index.rst @@ -0,0 +1,314 @@ +Raspberry Pi User Guide +======================= + +Required Hardware +----------------- + +**Development Kits** + +- :adi:`AD-GMSLCAMRPI-ADP# GMSL EV Kit Adapter Board ` +- :adi:`MAX96724 GMSL Deserializer Evaluation Kit ` +- :adi:`MAX96717 GMSL Serializer Evaluation Kit ` or *GMSL camera* +- :adi:`Raspberry Pi 4 Model B ` *(2GB of RAM or more preferred)* + +**Supported Image Sensors & Cameras** + +- `IMX219 Raspberry Pi Camera Module 2 `__ + +**Cables** + +.. Warning:: Do not use the 15-pin ribbon cable included with the Raspberry Pi camera since that is an opposite sided cable. + +- 15 Pin Type A (**same side**) Flexible Ribbon Cable, P/N: MP-FFCA10152003A or `Similar `__ +- 22 Pin Type B (**opposite side**) Flexible Ribbon Cable, P/N: MP-FFCA05222002B or `Similar `__ +- FAKRA Jack to FAKRA Jack coaxial cable, provided in EV kits + +.. image:: adaptor_block_diagram.png + + + +Board Modifications +------------------- + +Using the procedure to :dokuwiki:`Set CFG Pin Levels `, configure the serdes +pair as follows: + +==== ========================== ========================== + MAX96717 MAX96724 +==== ========================== ========================== +CFG0 **0** – I2C, ROR, 0x80 **0** – I2C, 0x4E +CFG1 **7** – Coax, 6Gbps, Pixel **0** – Coax, GMSL2, 6Gbps +==== ========================== ========================== + +.. Important:: It is required to set the CFG pins to the indicated levels for this setup. + + +For more information about the default CFG configuration of each evaluation +board, please visit the respective datasheet documentation: + +- :adi:`MAX98717EVKIT Datasheet ` +- :adi:`MAX98724EVKIT Datasheet ` + + +**GMSL Deserializer Evaluation Kit** + +- Slide the **SW5** switches to the ON position - enables I2C communication over the CSI bus +- Remove the **J18** and **J19** jumpers to allow the Rpi to become the Main host controller for the I2C lines. +- Make sure the **J3** is set as default **2-3** position to enable POC. + + .. image:: gmsl_deserializer_sw5.jpg + :width: 200 px + +- Bridge **R88** - provides VDDIO to the adapter + + .. image:: deserializer_resistors.jpg + :width: 200 px + + + +**GMSL Serializer Evaluation Kit** + +- Place a jumper on the **J10** connector - enables power over the coaxial cable + + .. image:: serializer_mods_j10.png + :width: 200 px + + +- Bridge **R70** - provides 12V to the adapter +- Bridge **R80** - connects MFP2 to the adapter for IMX219 +- Bridge **R66** - provides VDDIO to the adapter + + .. image:: serializer_mods_samtec_res.png + :width: 200 px + + +**AD-GMSLCAMRPI-ADP# Adapter** + +- Configure the switch **S2** on the GMSL Serializer adapter for CAM1 on connector **P9**. +- Configure the switch **S1** on the GMSL Deserializer adapter for CAM2 on connector **P6** and slide switch **S3** towards connector **P6**. + + +**Serializer Adapter** + +.. image:: serializer_interposer_cfg.png + :width: 300 px + +**Deserializer Adapter** + +.. image:: deserializer_interposer_cfg.png + :width: 300 px + + + + + +System Setup +------------ + +MAX96717 Serializer EV Kit Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For the following setup, please ensure ribbon cables and boards are oriented to +match the diagrams. + +Connect the 15-pin ribbon cable to the camera board. + +.. image:: step0.png + :width: 200 px + +Connect the other end of the 15 pin ribbon cable into the 15-to-22 pin adaptor +board. + +.. image:: step1.png + :width: 300 px + + +On the other side of the 15-to-22 pin adaptor board, connect the 22-pin ribbon +cable. **Note:** This is an opposite sided flex cable, please ensure it matches +the orientation in the picture. + +.. image:: step2.png + :width: 350 px + +Connect the other end of the 22 pin ribbon cable into the EV kit adaptor board +**P9** connector. + +.. image:: step3.png + :width: 400 px + +Lastly, connect the EV kit adaptor board to the MAX96717 EV kit. + +.. image:: step4.png + :width: 400 px + + +MAX96724 Deserializer EV Kit Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Starting with the Raspberry Pi 4B, connect the 15 pin ribbon cable to the CSI +input connector. + +.. image:: step5.png + :width: 200 px + +Connect the other end of the 15 pin ribbon cable into the 15-to-22 pin adaptor +board. + +.. image:: step6.png + :width: 300 px + +On the other side of the 15-to-22 pin adaptor board, connect the 22-pin ribbon +cable. **Note:** This is an opposite sided flex cable, please ensure it matches +the orientation in the picture. + +.. image:: step7.png + :width: 350 px + +Connect the other end of the 22 pin ribbon cable into the EV kit adaptor board +**P8** connector. + +.. image:: step8.png + :width: 400 px + +Lastly, connect the EV kit adaptor board to the MAX96724 EV kit. + +.. image:: step9.png + :width: 600 px + +With both sides of the SerDes devices connected up, the last step it to connect +the two sides together with the coax cable. The MAX96717 serializer only has one +connection. The MAX96724 deserializer has 4 inputs so connect the coax cable to +link A (INA) on **J7**. + +.. image:: gmsl_full_system_config.png + :width: 600 px + + +Connect power to the 12V barrel jack **J1** of the MAX96724 deserializer. If +utilizing the GMSL GUI, also connect the micro USB cable to **J6** of the +MAX96724 deserializer EV kit. + + + +Raspberry Pi 4 Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Connect the USB-C power supply to the Raspberry Pi 4 connector. +- Connect the HDMI cable from the monitor to the Raspberry Pi micro HDMI connector. +- Write the `Raspberry Pi latest SD card image `__ on a 8GB (or more) SD card. +- Plug the SD card into the Raspberry Pi 4 SD card slot. +- Connect a USB mouse and keyboard to the Raspberry Pi 4. It’s possible to use either a mouse & keyboard combo or a separate mouse and keyboard. + + + +Running the Evaluation Application +---------------------------------- + +Once Linux boots you’ll see on the HDMI monitor the Linux desktop and on the top +left corner a shortcut to the script named **video_cfg.sh**. Double-clicking on +the icon will start the media-ctl configuration script to connect to the V4L2 +media pipeline. It may not appear that anything happens but the script runs in +background without any pop ups. + +.. image:: rpi_video_cfg.png + +After the script runs, double-click on the Qt V4L2 test Utility icon to start +the video capture application. A window will open then press the green play +button to start video capturing. + +.. image:: rpi_qv4l2.png + +The capture window will look like below. + +.. image:: rpi_running_qv4l2.png + +.. note:: Some displays may have vertical/horizontal lines. This is typically an artifact caused on HDMI monitors and unrelated to the evaluation setup. + + +Power-off Sequence +~~~~~~~~~~~~~~~~~~ + +- Open a terminal and type **sudo poweroff**. This will safely power off the Raspberry Pi 4 and ensure that the SD card is properly unmounted. +- Remove the power supply from the Raspberry Pi 4. +- Remove the power supply from the MAX96724 EV kit. + + + +Getting the Software +-------------------- + +The GMSL Linux kernel drivers, the complete Linux distributions for the +supported processing platforms, and software user guides can be found on the +`Analog Devices GMSL GitHub repository `__. + + + +Tips for Troubleshooting +------------------------ + +There are a few key commands in the Linux environment that can help identify if +the expected connections and communications have been made. + +#. In the Linux environment, you can check to see if the Rpi I2C is detecting + the GMSL boards by sending a I2C detect command [1]_ as follows: + :: + + $ sudo i2cdetect -y 10 + + The Result should look as follows in the terminal: + :: + + analog@kuiper-gmsl:~$ sudo i2cdetect -y 10 + [sudo] password for analog: + 0 1 2 3 4 5 6 7 8 9 a b c d e f + 00: -- -- -- -- -- -- -- -- + 10: UU -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- + 20: -- -- -- -- -- -- -- UU -- -- -- -- -- -- -- -- + 30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- + 40: 40 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- + 50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- + 60: -- -- -- -- 64 -- -- -- -- -- -- -- -- -- -- -- + 70: -- -- -- -- -- -- -- -- + +#. You can also confirm that the video for Linux application is detecting the + camera and GMSL devices by using the following command: + :: + + $ v4l2-ctl --list-devices + + The response should look like the following: + :: + + analog@kuiper-gmsl:~$ v4l2-ctl --list-devices + bcm2835-codec-decode (platform:bcm2835-codec): + /dev/video10 + /dev/video11 + /dev/video12 + /dev/video18 + /dev/video31 + /dev/media2 + + bcm2835-isp (platform:bcm2835-isp): + /dev/video13 + /dev/video14 + /dev/video15 + /dev/video16 + /dev/video20 + /dev/video21 + /dev/video22 + /dev/video23 + /dev/media1 + /dev/media3 + + unicam (platform:fe801000.csi): + /dev/video0 + /dev/video1 + /dev/media4 + + rpivid (platform:rpivid): + /dev/video19 + /dev/media0 + + The key is to identify the **unicam** output, which correspond to the Rpi + camera setup. + diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_qv4l2.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_qv4l2.png new file mode 100644 index 00000000..ea06074e --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_qv4l2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:06280165125b6a12f721ccaa5240c324dc532950d56597b0ad7cca447413dbee +size 191454 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_running_qv4l2.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_running_qv4l2.png new file mode 100644 index 00000000..dc917db1 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_running_qv4l2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9b7a639dea8893750aa955a17d28e15fa25ad462146b9c24876c2d7b63caaf34 +size 404039 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_video_cfg.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_video_cfg.png new file mode 100644 index 00000000..c83ecf18 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/rpi_video_cfg.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6f7652ccdb6b81d0ec861f5d80569143ebdb9956abb27b225900172868b4925b +size 187617 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_interposer_cfg.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_interposer_cfg.png new file mode 100644 index 00000000..69aeb27e --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_interposer_cfg.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:125ca3dda272e0a5865ee5c06941cffff1e22b2a9367449de4a9d03ca3e5537b +size 860112 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_j10.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_j10.png new file mode 100644 index 00000000..cdb8d1f3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_j10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d1cfd57f9c720ede0d9f291542d83c239937a383c21d3a9ef2ea6a0f763f5ce +size 444964 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_samtec_res.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_samtec_res.png new file mode 100644 index 00000000..0a9c7906 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/serializer_mods_samtec_res.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9762fad6119b416d06cd69f8bf0a8579141c40f6dcf6f7b132404a6e22f4fad6 +size 482842 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step0.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step0.png new file mode 100644 index 00000000..59e5e783 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step0.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:acb14d1a6a748b1926047810ec58e94cb9fadab952b528bcdc2f137724abdbf0 +size 299599 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step1.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step1.png new file mode 100644 index 00000000..2283c83e --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f2422a55e391be7d7f72224b5e5cc52a4c7ff5d4d98b50183883065e52a910ce +size 394838 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step2.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step2.png new file mode 100644 index 00000000..62122d72 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ea81bf040c4232d0405186828f6e6fe945704318e08025877024adf42dda3f4b +size 229175 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step3.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step3.png new file mode 100644 index 00000000..0800523c --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27ec7a04362d22caf4959a901ca21c8da2f573b3897858eda5ad7671828ddf4c +size 364905 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step4.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step4.png new file mode 100644 index 00000000..e851ed8c --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b6f9ab4d571991dad92d4029d8b1eda1a544ab5e7f33a6da53a9cde5e63cacd +size 300358 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step5.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step5.png new file mode 100644 index 00000000..94e061d4 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:67e4eff0c61add2c6a9a7204860f903ab75346a6393dddde4d7cbc0542f07fb3 +size 663866 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step6.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step6.png new file mode 100644 index 00000000..5fb17ba9 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step6.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:04ed679aa8d16bd869a0d1d98d2310ca131565734f30180ad8875db5dbeb548d +size 524705 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step7.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step7.png new file mode 100644 index 00000000..2ea19180 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step7.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8a5fc84290a0a04c8e5dffe303ac2c34092da2f0b170c7da5f6544777bae78f3 +size 366175 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step8.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step8.png new file mode 100644 index 00000000..4fd492b8 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step8.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddd8bf1573ab5168ce4069a08dd9a3679e818c4af70fc572f7f7babd7cb4bc1a +size 348123 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step9.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step9.png new file mode 100644 index 00000000..3d2f1528 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/raspberry-pi-user-guide/step9.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:61d7952309e150026230e0f56bbe9582d0a0f5ef901a2b17c6b941d842b90fa2 +size 278540 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/signal_chain.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/signal_chain.png new file mode 100644 index 00000000..b5876de4 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/signal_chain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:122f1754863f7d77845b13ca8f0a1895e86596fdc59b6654a78a71442699fda4 +size 187047 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/specifications.csv b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/specifications.csv new file mode 100644 index 00000000..c4660242 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/specifications.csv @@ -0,0 +1,14 @@ +Ribbon Cable Adapter, +Connectors,"2 x 15 Pin Type A (same side) Flexible Ribbon Cable (2 x MIPI lanes, P/N: 1-84953-5)" +,2 x 22 Pin Type B (opposite side) Flexible Ribbon Cable (P/N: 687122149022) +Power,Routing 3.3V external power between pairs of 15-pin and 22-pin connectors +GMSL Serializer EVK Adapter, +Connectors,1 x GMSL Serializer EV kit (P/N: QSH-030-01-L-D-A) +,"2 x 22-pin (4 x MIPI lanes, P/N: 687122149022)" +Power,Input: 12V from GMSL Serializer EV kit +,Output: 3.3V at 0.5A on the 22-pin connectors +GMSL Deserializer EVK Adapter, +Connectors,1 x GMSL Deserializer EV kit (P/N: QTH-030-01-L-D-A) +,"2 x 22-pin (4 x MIPI lanes, P/N: 687122149022)" +Power,Input: 12V from GMSL Deserializer EV kit +,Output: 5V at 4A on the USB Type A connector to power external devices diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsl15adp22ser.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsl15adp22ser.png new file mode 100644 index 00000000..36d1ed5e --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsl15adp22ser.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e73cb376bee0ca22668788d0dbbb2115c14895bb8490722af70824fb0108fd9a +size 82580 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesjeto.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesjeto.png new file mode 100644 index 00000000..015c0fe3 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesjeto.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1944e9ddad8242a26f01555aad65f8f660932801b730341f2c697bf15db9109e +size 304660 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesrpi4.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesrpi4.png new file mode 100644 index 00000000..7037b708 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladpdesrpi4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:40bc379bb40d9cb907195506463d3a0d2ef2ad7f90b69b5139683f14c10f0c71 +size 314840 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladptop.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladptop.png new file mode 100644 index 00000000..4a0a31a5 --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmsladptop.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:86bf430868aa6532bb1cfc612929575cc5a9b31b166ad6641906162b018487b3 +size 379399 diff --git a/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmslcamadpser.png b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmslcamadpser.png new file mode 100644 index 00000000..0fda049b --- /dev/null +++ b/docs/solutions/reference-designs/ad-gmslcamrpi-adp/wikigmslcamadpser.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1506b063ac59a46036db702cddc0dffd69e3d4349c6b19c56e2ab2192e3c280d +size 321993 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/10base-t1l-port.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/10base-t1l-port.jpg new file mode 100644 index 00000000..f9cb56f7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/10base-t1l-port.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fa21c06099200ee075b0ccd6227de8f845cfc84c3bf14b82859a5a7cd7cbccb +size 5906 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/63305_2.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/63305_2.jpg new file mode 100644 index 00000000..d6b1f933 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/63305_2.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a199549f1e90c05399464771dd569f2b9fac9fb8734c1de2694a9216b42fb9d +size 24977 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/CN0575-DesignSupport.zip b/docs/solutions/reference-designs/eval-cn0575-rpiz/CN0575-DesignSupport.zip new file mode 100644 index 00000000..96995bc7 Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0575-rpiz/CN0575-DesignSupport.zip differ diff --git "a/docs/solutions/reference-designs/eval-cn0575-rpiz/I\302\262C-Bus-Address-Selection.csv" "b/docs/solutions/reference-designs/eval-cn0575-rpiz/I\302\262C-Bus-Address-Selection.csv" new file mode 100644 index 00000000..435a4760 --- /dev/null +++ "b/docs/solutions/reference-designs/eval-cn0575-rpiz/I\302\262C-Bus-Address-Selection.csv" @@ -0,0 +1,9 @@ +JP6,JP7,JP8,I2C Bus Address +B,B,B,0x48 (Default) +B,B,A,0X49 +B,A,B,0X4A +B,A,A,0X4B +A,B,B,0X4C +A,B,A,0X4D +A,A,B,0X4E +A,A,A,0X4F diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/JP14-setting.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP14-setting.csv new file mode 100644 index 00000000..0af232b4 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP14-setting.csv @@ -0,0 +1,3 @@ +JP14 Setting,Connection +Open,TEST button is connected to GPIO16 of the Raspberry Pi (Default). +Shorted,TEST button is not connected to the Raspberry Pi. diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/JP15-Setting.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP15-Setting.csv new file mode 100644 index 00000000..21d18421 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP15-Setting.csv @@ -0,0 +1,3 @@ +JP15 Setting,Connection +Open,ALERT LED is connected to GPIO26 of the Raspberry Pi (Default). +Shorted,ALERT LED is not connected to the Raspberry Pi. diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/JP3-Setting.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP3-Setting.csv new file mode 100644 index 00000000..e7828e2d --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/JP3-Setting.csv @@ -0,0 +1,3 @@ +JP3 Setting,Software Power-Down Configuration +Open,PHY enters software PD mode after a reset operation (Default). +Shorted,PHY does not enter software PD mode after a reset operation. diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/Optional-GPIO-Pins.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/Optional-GPIO-Pins.csv new file mode 100644 index 00000000..5d0d4df8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/Optional-GPIO-Pins.csv @@ -0,0 +1,7 @@ +Jumper,GPIO,Circuit Function,Description +JP9,GPIO27,ADIN1110 Reset,This an active low ADIN1110 input that resets the part when held low for >10 μs. +JP10,GPIO22,ADIN1110 Link Status Output,This is an active high ADIN1110 output that indicates whether a valid 10BASE-T1L link has been established. +JP11,GPIO23,Time Stamp Capture Signal,Assert this pin to timestamp the latest incoming frame received by the ADIN1110. The captured timestamp will be stored in the TS_EXT_CAPT0 and TS_EXT_CAPT1 registers. +JP12,GPIO24,Time Stamp Timer Signal,"This pin is connected to the TS_TIMER pin of the ADIN1110. When the TS_TIMER output is enabled in the device registers, a waveform with high and low times set by the TS_TIMER_HI and TS_TIMER_LO registers is generated." +JP13,GPIO6,Overtemperature Indicator,"This pin is asserted when the onboard ADT75 temperature sensor is put into one-shot mode and the temperature measurement exceeds TOS (80°C; default value). By default, the indicator is active low and will only be de-asserted when the temperature drops below THYST (75°C; default value). The temperature sensor can be reprogrammed to change the polarity of this pin, the de-assertion requirement, and the values of TOS and THYST." +,,, diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/SPoE_PD_Power_Class_Selection.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/SPoE_PD_Power_Class_Selection.csv new file mode 100644 index 00000000..33223793 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/SPoE_PD_Power_Class_Selection.csv @@ -0,0 +1,7 @@ +JP1 Shunt Position,JP2 Shunt Position,PD Class,VPD(min),PPD(max) +Across Pins 2 and 3,Across Pins 2 and 3,10,14 V,1.23 W +Across Pins 2 and 3,No Shunt Inserted,11,,3.20 W +Across Pins 2 and 3,Across Pins 1 and 2,12,,8.40 W +Across Pins 1 and 2,Across Pins 2 and 3,13,35 V,7.70 W +Across Pins 1 and 2,No Shunt Inserted,14,,20.0 W +Across Pins 1 and 2,Across Pins 2 and 3,15,,52.0 W diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/adin1110-leds.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/adin1110-leds.jpg new file mode 100644 index 00000000..6c4a52f8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/adin1110-leds.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5d36fd6e9b783e979de721eb2b4961fee7f5e25d96a15bb848f4683dbb21cec7 +size 13023 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/adt75-example.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/adt75-example.png new file mode 100644 index 00000000..ec9f2de9 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/adt75-example.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d968d15f276abe59ed6ececb53078d3add6f385f410503303cda1e9937d619d3 +size 50155 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/block_diagram-new-2.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/block_diagram-new-2.png new file mode 100644 index 00000000..c1ed6b70 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/block_diagram-new-2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:172b950a6e9994cf0b48c1ae0074f68a10a7d2e7977252f1ed4b77e5781a776e +size 109319 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/c16_marking.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/c16_marking.png new file mode 100644 index 00000000..5d9f8aea --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/c16_marking.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5e9f5584b1d00579f76df93aa23614d18a92ff2a59d7552e2c3ee90e71cfe02c +size 30056 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/cn0575_example_screenshot.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/cn0575_example_screenshot.png new file mode 100644 index 00000000..d81b37e2 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/cn0575_example_screenshot.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8109819bf635fb0b99f0631fdd323b799e640610fd0cf5b4a1047754f35f38fe +size 85328 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/command_prompt.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/command_prompt.png new file mode 100644 index 00000000..d8f6f857 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/command_prompt.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7bb109674ddb514d8791eb1539e191a682d06d430465ce659a177222b1454473 +size 67225 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-bottom-with-labels.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-bottom-with-labels.png new file mode 100644 index 00000000..a969ab41 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-bottom-with-labels.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:396d855aae02e3b730ff8ae5394a1fc13444d20cebcd3e1a36e77b1a4c6bd797 +size 264301 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-top-with-labels.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-top-with-labels.png new file mode 100644 index 00000000..911238c7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/eval-cn0575-rpiz-top-with-labels.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f4a1117dd18df80180ff77f8e61fbafce4263abac45fd4e4331a62477c8e33c +size 229609 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/ifconfig.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/ifconfig.png new file mode 100644 index 00000000..5d8fc567 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/ifconfig.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:32a2b07b530f7b06dc25244357429a1eb88fc5ff15b1697604bc35b40f9919bc +size 247270 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/index.rst b/docs/solutions/reference-designs/eval-cn0575-rpiz/index.rst new file mode 100644 index 00000000..55dd04b3 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/index.rst @@ -0,0 +1,464 @@ +.. _eval-cn0575-rpiz: + +================= +EVAL-CN0575-RPIZ +================= + + +General Description +------------------- + +The :adi:`EVAL-CN0575-RPIZ ` is a 10BASE-T1L MAC/PHY interface with +Single Pair Power over Ethernet (SPoE) for development of field devices and +applications on a Raspberry Pi platform board. The SPoE powered device (PD) and +isolated flyback regulator provide 5 V power to the platform board and attached +application circuitry. SPoE Class 12 (8.4 W, 24 V nominal) and Class 13 (7.7 W, +55 V nominal) are supported. + +Designed for use on the Raspberry Pi platform, the CN0575 hardware features a 40-pin GPIO header, and follows the same mechanical dimensions as a standard HAT. + +To allow board stacking and development of field device applications using Raspberry Pi HATs, an additional GPIO header with extended leads is included with each evaluation board. However, the :adi:`CN0575` can also be used on its own as a basic temperature sensing field device with remote user input/output via an onboard button and LED. + + +.. image:: 63305_2.jpg + + +Evaluation Board Hardware +------------------------- + +Primary Side +~~~~~~~~~~~~ + +.. image:: eval-cn0575-rpiz-top-with-labels.png + + + +10BASE-T1L Port (P1 and P2) +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. image:: 10base-t1l-port.jpg + + +The :adi:`EVAL-CN0575-RPIZ ` evaluation board uses a single +port 10BASE-T1L device and can be connected to a link partner using either one +of the two physical connectors provided: + +- The **P1 terminal block** is used for connecting individual wires. Connect the + twisted pair to pins 1 and 2, and the shield (if available) to pin 3. Secure + the connections by tightening the screws on the terminal block. +- The **P2 port** is used for connecting standard IEC 63171-6 cables directly + from a 10BASE-T1L-capable controller unit. + + + +PHY Status Indicators (LED0 and LED1) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +**LED0** and **LED1** are the :adi:`ADIN1110` +status indicators, and can be configured to display various activities via the +device registers. + +By default, **LED0** is set to turn on when a link is established and blink +when there is activity; while **LED1** is disabled. Refer to the LED Control + +Register in the :adi:`ADIN1110` data sheet for a full list of +available functions. + + + +General Purpose LED and Button (ALERT and TEST) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :adi:`EVAL-CN0575-RPIZ ` evaluation board includes a simple +button (**TEST**) and LED (**ALERT**) circuit that can be respectively used as +a digital input and a general purpose indicator. This circuit is controlled by +the Raspberry Pi by default (via **GPIO16** and **GPIO26**), but can +alternatively be used with external hardware by changing the appropriate +jumper settings (refer to Connecting the General Purpose LED and Button to +External Hardware). + +.. image:: adin1110-leds.jpg + +The **GPIO16** pin is normally pulled high in this circuit, but will read low +when the **TEST** button is pressed. + + +SPoE PD Power Class Selection (JP1 and JP2) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +By default, the :adi:`LTC9111` SPoE PD +controller included in the :adi:`CN0575` circuit is configured for +PD Class 12. If a different PD class is required for the application, the +**JP1** and **JP2** solder jumpers should be reconfigured to match the desired +class. + +.. image:: ltc9111-jumpers.jpg + +.. csv-table:: SPoE PD Power Class Selection + :file: SPoE_PD_Power_Class_Selection.csv + + +The :adi:`EVAL-CN0575-RPIZ ` was designed and evaluated for PD Classes 12 and 13. However, Classes 10 and 11 may still be +usable, depending on the power requirements of the Raspberry Pi model used (and +its peripherals). + +.. :admonition:: Warning + Do not use PD Classes 14 and 15. + + The :adi:`EVAL-CN0575-RPIZ ` evaluation board is not designed to handle these higher power specifications. + + + +Secondary Side +~~~~~~~~~~~~~~ + +.. image:: eval-cn0575-rpiz-bottom-with-labels.png + + +ADIN1110 SW Power-Down Enable and SPI Configuration (JP3 to JP5) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The :adi:`EVAL-CN0575-RPIZ ` evaluation board uses +the default hardware configuration for the PHY specified in the +:adi:`ADIN1110` data sheet. If a different operating mode is +required for the application, the :adi:`ADIN1110` should first be +placed into software power-down and then configured appropriately via the +device registers. + +.. image:: jp3-jp4-jp5.jpg + +Refer to the table below on setting the **JP3** jumper to enable/disable the +software power-down feature: + + +.. csv-table:: ADIN1110 SW Power-Down Enable and SPI Configuration + :file: JP3-Setting.csv + +The :adi:`ADIN1110` supports both generic SPI and the OPEN +Alliance SPI protocol in its communication. Refer to the table below on +setting **JP4** and **JP5** to select the SPI protocol: + + +.. csv-table:: SPI Protocol Setting + :file: jp4-jp5-settings.csv + + + +ADT75 I²C Bus Address Selection (JP6 to JP8) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The I²C bus address of the onboard :adi:`ADT75` +temperature sensor is dependent on the settings of the **JP13**, **JP14**, and +**JP15** solder jumpers. **Note:** The CN0575 device tree overlay in ADI +Kuiper Linux has the temperature sensor I²C address set to the default 0x48. + +.. image:: jp6-jp7-jp8.jpg + + +If there is a need to reassign the :adi:`ADT75` address, refer to the +following table: + +.. csv-table:: ADT75 I²C Bus Address Selection + :file: I²C-Bus-Address-Selection.csv + + + +Optional GPIO Pins (JP9 to JP13) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. image:: jp11-jp12-jp13.jpg + + +By default, some functions of the :adi:`ADT75` are +connected to various GPIO pins of the Raspberry Pi. If these features will not +be used in the application, the corresponding jumpers can be removed - doing +this will allow these GPIO pins to be used for other external hardware. + +.. csv-table:: Optional GPIO Pins + :file: Optional-GPIO-Pins.csv + + + +General Purpose LED and Button Connections (JP14 and JP15) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. image:: jp14-jp15.jpg + +While normally functioning as a digital input and general +purpose indicator respectively, the **TEST** button and **ALERT** LED can +alternatively be used for external applications by changing the settings of +the appropriate jumpers. **JP14** is used to set the button connection, while +**JP15** is used to set the LED connection. + +.. csv-table:: JP14 Setting + :file: JP14-setting.csv + +.. csv-table:: JP15 Setting + :file: JP15-Setting.csv + +.. tip:: + + External hardware can be connected to the **TEST** + button and **ALERT** LED using the **BTN_IO** and **LED_IO** test points, + respectively. + + +System Setup +------------ + + **Required Equipment** + + **Hardware** + + - :adi:`EVAL-CN0575-RPIZ ` Circuit Evaluation Board + - Raspberry Pi Model 3B (or higher) + - Micro-SD Card for Raspberry Pi + - 10BASE-T1L media converter, either: + - :adi:`EVAL-ADIN1100EBZ ` Product Evaluation Board + - Other 10BASE-T to 10BASE-T1L media converter + - USB to 10BASE-T1L + - Power Source, either: + - 10BASE-T1L Power Coupling Network Board w/ SPoE PSE or DC Power Supply + - USB-C or USB-Micro 5V wall adapter (plugged directly into Raspberry Pi) + - Host Windows, Linux, or Mac computer + + **Software** + + - :dokuwiki:`Analog Devices Kuiper Linux ` + - `PuTTY `__ + + **Documentation** + + - :adi:`CN0575` Circuit Note + + + +Block Diagram +~~~~~~~~~~~~~ + +Setup with SPoE via PSE or DC Power Supply: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Power coupling boards compatible with the EVAL-ADIN1100 for +various SPoE classes and droop levels are in development. Alternatively, use a +media converter that supports SPoE PSE functionality. + +Refer to the LTC4296-1 datasheet for example coupling networks. + +.. image:: test-setup-block-diagram.png + + +Setup without SPoE (USB-Powered Application): +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. image:: block_diagram-new-2.png + + +Software Setup +~~~~~~~~~~~~~~ + +Downloading and Flashing the Micro-SD Card +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To use the :adi:`EVAL-CN0575-RPIZ ` with the Raspberry Pi, the +micro-SD card should be preloaded with :dokuwiki:`Analog Devices Kuiper Linux `, +a distribution based on Raspbian from the Raspberry Pi Foundation that +incorporates Linux drivers for ADI products as well as tools and other +software products. + +Complete instructions, including where to download the SD card image, how to +write it to the micro-SD card, and how to configure the system are provided at +`Kuiper Images `. + + +.. image:: command_prompt.png + + + +Configuring the Micro-SD Card +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Linux kernel requires a matching device tree overlay to identify the +devices on the CN0575. The overlay table is included with the :dokuwiki:`Analog Devices Kuiper Linux ` +and simply needs to be enabled. + +To do this, follow the Hardware Configuration procedure under **Configuring +the SD Card for Raspberry Pi Projects** in the :dokuwiki:`Analog Devices Kuiper Linux ` page. +Enable the CN0575 overlay by adding the following line to *config.txt*: + +:: + + dtoverlay=rpi-cn0575 + +Save the table and reboot the system by entering the following command in the console: + +:: + + analog@analog:~$ sudo reboot + + + +Determining the IP Address of the CN0575 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Follow the below procedure to determine the IP address assigned by the Raspberry +Pi to the :adi:`EVAL-CN0575-RPIZ `: + +#. Complete the hardware setup described in the Basic Operation section. +#. Remove the Ethernet cable from the :adi:`EVAL-ADIN1100EBZ ` + evaluation board and connect it directly to the Raspberry Pi. +#. Run PuTTY and connect to the Raspberry Pi via SSH. For the Host Name (or IP + address), use **analog.local**. +#. Enter the command *ifconfig* in the console. +#. The IP address of the :adi:`EVAL-CN0575-RPIZ ` board will be listed + as inet under adin1110-0. In the example below, the IP address is + 169.254.158.120. + + +.. image:: ifconfig.png + + + +Basic Operation +~~~~~~~~~~~~~~~ + +.. image:: setup.jpg + +To establish a 10BASE-T1L connection to a Raspberry Pi using the +:adi:`EVAL-CN0575-RPIZ ` evaluation board and run a basic temperature +measurement example, follow the below procedure: + + 1. Ensure that the jumpers and switches of the :adi:`EVAL-ADIN1100EBZ ` are configured to the default settings. + + 2. Insert the micro-SD card into its slot on the Raspberry Pi. + + 3. Connect the :adi:`EVAL-CN0575-RPIZ ` circuit evaluation board to the Raspberry Pi GPIO header. + + 4. Using an Ethernet cable, connect **P5** on the + :adi:`EVAL-ADIN1100EBZ ` evaluation board to an RJ-45 port on + the computer. + + 5. Using a micro-USB cable, connect **P401** on the + :adi:`EVAL-ADIN1100EBZ ` evaluation board to a USB port on + the computer. + + 6. *Operation with SPoE PSE or DC Power Supply: (Skip to step 7 if using a USB + wall adapter instead)* + * Set the output of the PSE or DC power supply to either 24V (Class 12) or 55V (Class 13), depending on the settings of **JP1** and **JP2** on the CN0575 board. + * Using wires, connect the output of an SPoE power coupler to the **P1** terminal block on the :adi:`EVAL-CN0575-RPIZ ` circuit evaluation board. Similarly, connect the data input of the power coupler to the **P101** terminal block on the :adi:`EVAL-ADIN1100EBZ ` evaluation board. + * Connect the output of the SPoE PSE (or DC power supply) to the power input of the SPoE power coupler and enable it. + +7. *Operation without SPoE (USB-Powered Application):* + * Using wires, connect the **P1** terminal block on the :adi:`EVAL-CN0575-RPIZ ` circuit evaluation board to the **P101** terminal block on the :adi:`EVAL-ADIN1100EBZ ` evaluation board. + * Connect the USB wall adapter to the power connector on the Raspberry Pi. + +8. Wait for the **LINK** LED on the :adi:`EVAL-CN0575-RPIZ ` circuit evaluation board and the **LED_0** LED on the :adi:`EVAL-ADIN1100EBZ ` evaluation board to turn on and start blinking at the same time. This indicates that a 10BASE-T1L link has been established. + +9. On the host PC, run PuTTY and connect to the Raspberry Pi using the :adi:`EVAL-CN0575-RPIZ ` IP address. + +10. In the Raspberry Pi console, navigate to the examples directory of pyadi-iio. Run the temperature measurement example by entering the following command: + + +:: + + .../pyadi-iio/examples $ sudo python lm75_example.py + + + +.. image:: adt75-example.png + + + + +More Complete Example with Digital I/O +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +| A more complete example that blinks the onboard LED and reads the push button + is also provided. Note that this script can be run either directly on the + Raspberry Pi, or remotely from a host computer. +| From the Raspberry Pi command line, run: + +:: + + .../pyadi-iio/examples $ sudo python cn0575_example.py + +Or from PowerShell on a Windows remote host, run: + +:: + + ...\pyadi-iio\examples> python .\cn0575_example.py + +The script will attempt to automatically locate the CN0575 over the network +connection. The CN0575’s IIO context URI can also be passed to the script +explicitly, where **www.xxx.yyy.zzz** is the board’s IP address: + +:: + + C:\temp\pyadi-iio\examples> python .\cn0575_example.py ip:www.xxx.yyy.zzz + + +Typical output is shown below: + +.. image:: cn0575_example_screenshot.png + + + +Errata +------ +.. image:: c16_marking.png + +The first batch of :adi:`EVAL-CN0575-RPIZ ` circuit +evaluation boards that was produced mistakenly have a 50V capacitor installed +on C16. This voltage rating is insufficient for Class 13 operation where the +SPoE voltage can be as high as 58 V (and potentially even more during surge +events). + +These boards can be identified by the last three letters on C16 (HTH, shown +right). If you have one of these and intend to use it in a Class 13 +application, either replace C16 with a 100 V capacitor (preferred; this is the +same rating used in later batches of the :adi:`EVAL-CN0575-RPIZ `), +or simply desolder it and leave it empty. + + + +Schematic, PCB Layout, Bill of Materials +---------------------------------------- + +.. admonition:: Download + + `EVAL-CN0575-RPIZ Design & Integration tables `_ + + - Schematics + - PCB Layout + - Bill of Materials + - Allegro Project + + +Additional Information and Useful Links +--------------------------------------- + +- :adi:`CN0575 Circuit Note Page ` +- :adi:`CN0575 Design Support Package ` +- :adi:`ADIN1110 Product Page ` +- :adi:`ADT75 Product Page ` +- :adi:`LTC9111 Product Page ` +- :adi:`LT8304 Product Page ` +- :adi:`ADIN1110 Linux Driver ` +- `ADT75 Linux Driver `_ + + + +Hardware Registration +--------------------- +.. tip:: + + Receive software update notifications, documentation updates, view the latest videos, and more when you :adi:`register ` your hardware. + + + +Help and Support +------------------- + +For questions and more information about this product, connect with us through the Analog Devices :ez:`EngineerZone Support Community` . + + diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/jp11-jp12-jp13.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp11-jp12-jp13.jpg new file mode 100644 index 00000000..062e8037 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp11-jp12-jp13.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfeb95829300848e6cd48bf3a011d9106adfc258fc4a55acb71ddd9f2c7f304e +size 10964 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/jp14-jp15.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp14-jp15.jpg new file mode 100644 index 00000000..d2bcef39 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp14-jp15.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5a2f72d398d77b59932f1e672e37ac8e860d699deed84b38455a02530785fc15 +size 10171 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/jp3-jp4-jp5.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp3-jp4-jp5.jpg new file mode 100644 index 00000000..e01d6f5c --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp3-jp4-jp5.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aa14237158af9c09182aa62e667711422f66953e0b7128b52b915c00e7e731aa +size 21574 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/jp4-jp5-settings.csv b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp4-jp5-settings.csv new file mode 100644 index 00000000..728c5379 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp4-jp5-settings.csv @@ -0,0 +1,5 @@ +JP4 Setting,JP5 Setting,SPI Protocol +Open,Open,OPEN Alliance with Protection +Open,Shorted,OPEN Alliance without Protection +Shorted,Open,Generic SPI with 8-bit CRC +Shorted,Shorted,Generic SPI without 8-bit CRC (Default) diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/jp6-jp7-jp8.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp6-jp7-jp8.jpg new file mode 100644 index 00000000..a9f61d6a --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/jp6-jp7-jp8.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f5f99a03e0f0abc5689ed2dcc0c89702e9fa03ed3c473419a7cfd1e875e6bdc +size 14033 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/ltc9111-jumpers.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/ltc9111-jumpers.jpg new file mode 100644 index 00000000..3a7488a7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/ltc9111-jumpers.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e18e9a64bdc8bbb62eae0f2e2855b72b8a6df57cc2d7ca3727359375a6d056ae +size 6641 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/setup.jpg b/docs/solutions/reference-designs/eval-cn0575-rpiz/setup.jpg new file mode 100644 index 00000000..f8aa0311 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/setup.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0139e68012f0ff460eb0902014da3a67b82ac32b911afd22549e2889ee257cb1 +size 35299 diff --git a/docs/solutions/reference-designs/eval-cn0575-rpiz/test-setup-block-diagram.png b/docs/solutions/reference-designs/eval-cn0575-rpiz/test-setup-block-diagram.png new file mode 100644 index 00000000..7e84d657 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0575-rpiz/test-setup-block-diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f741d2a063d05424e1f4a9a08ea2f8b619ecdde6070934c4db64bfa1e8f3020d +size 127682 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/577_debug_panel.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_debug_panel.png new file mode 100644 index 00000000..ee51e601 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_debug_panel.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d09cf58c601be1fedcac482b0a57b36ef39ca657679153afbe73756c21be5996 +size 23028 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/577_dmm_panel.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_dmm_panel.png new file mode 100644 index 00000000..04c9679f --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_dmm_panel.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0edf63a55a70b5d3d9c81a593003bea35480ec8ab663e9bfa767cb5944ce6a25 +size 33134 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/577_osc.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_osc.png new file mode 100644 index 00000000..c08cb457 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/577_osc.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c18c1549618b864f00648b1b7da11b01fb452a876e5f354e05c150def1a44350 +size 126668 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/CN0577-DesignSupport.zip b/docs/solutions/reference-designs/eval-cn0577-fmcz/CN0577-DesignSupport.zip new file mode 100644 index 00000000..5e22fca7 Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0577-fmcz/CN0577-DesignSupport.zip differ diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/cn0577_block_diagram.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/cn0577_block_diagram.png new file mode 100644 index 00000000..4566979d --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/cn0577_block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:d67d898602d356c678e545822b5d6bd51601b35c9f16b131378f45e1e24b6aba +size 264818 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/index.rst b/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/index.rst new file mode 100644 index 00000000..9a96a27c --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/HDL-reference-design/index.rst @@ -0,0 +1,242 @@ +HDL Reference Design +========================== + +Introduction +------------ + +The :adi:`CN0577 ` provides an analog front-end and an FMC digital +interface for :adi:`LTC2387-18 `, its core. It is a low noise, high +speed successive approximation register (SAR) ADC with a resolution of 18 bits +and sampling rate up to 15 MSPS. + +CN0577 includes an on-board reference oscillator and a retiming circuit to +minimize signal-to-noise ratio (SNR) degradation due to the FPGA additive +jitter. + +In order to support high speed operations while minimizing the number of data +lines, a serial LVDS digital interface is used. It has a one-lane and two-lane +output modes, allowing the user to optimize the interface data rate for each +application, through setting a parameter. + +More details about ADI reference designs architecture :dokuwiki:`here `. + + +Evaluation Board +---------------- + +- :adi:`CN0577 Circuit Note Page ` +- :adi:`LTC2387-18` chip + + +Supported FPGA Carriers +----------------------- + +- `ZedBoard `__ + + +HDL Design Description +---------------------- + +.. Important:: + In the master version, the TWOLANES parameter is set to 1, so it works only in two-lane output mode. + + **The VADJ for the Zedboard must be set to 2.5V!** + + +The PD and TESTPAT parameters are tied to GPIOs (33 and 32 respectively) so they +can be configured by the software. + +The conversion starts when a rising edge is detected on the CNV signal. This +signal is generated by the :dokuwiki:`AXI_PWM_GEN ` +core, alongside with a clk_gate signal. + + +Block Diagram +~~~~~~~~~~~~~ + +.. image:: cn0577_block_diagram.png + :width: 600 px + + +Parameters +~~~~~~~~~~ + +The only parameter that can be changed so far, is ``TWOLANES``. It specifies +whether the two-lane output mode is activated or not. When activated, the ADC +outputs two bits at the same time, on DA+/DA- and DB+/DB-. When it is low, then +DB+/DB- is disabled. + +By default, it is set to 1 `here `_ and passed +further through the board design file `here `_. + + +PL Interrupts +^^^^^^^^^^^^^ + +When developing the Linux software parts for an HDL project, the interrupts +number to the PS have a different number in the software side. More details +:dokuwiki:`here `. + +=============== =========== ========== =========== +Interr. name HDL interr. Linux Zynq Actual Zynq +=============== =========== ========== =========== +axi_ltc2387_dma 13 57 89 +=============== =========== ========== =========== + +GPIO signals +^^^^^^^^^^^^ + +PS7 EMIO offset = 54 + +============= ======== ============ +GPIO HDL name GPIO nb. HDL GPIO nb. +============= ======== ============ +pd_cntrl 87 33 +testpat_cntrl 86 32 +============= ======== ============ + +I/O Interface +~~~~~~~~~~~~~ + ++--------------------+--------------------+------------+--------------------+ +| Interface | Pin | Type | Description | ++====================+====================+============+====================+ +| **Core clock** | | | | ++--------------------+--------------------+------------+--------------------+ +| | ``ref_clk_*`` | ``input`` | LVDS clock input | ++--------------------+--------------------+------------+--------------------+ +| **LVDS ADC | | | | +| interface** | | | | ++--------------------+--------------------+------------+--------------------+ +| | ``clk_*`` | ``output`` | LVDS output clock | +| | | | going to the chip, | +| | | | to serially shift | +| | | | out the conversion | +| | | | result | ++--------------------+--------------------+------------+--------------------+ +| | ``dco_*`` | ``input`` | LVDS data clock | +| | | | input | ++--------------------+--------------------+------------+--------------------+ +| | ``da_*`` | ``input`` | Serial LVDS data | +| | | | input | ++--------------------+--------------------+------------+--------------------+ +| | ``db_*`` | ``input`` | Serial LVDS data | +| | | | input | ++--------------------+--------------------+------------+--------------------+ +| | ``cnv_*`` | ``output`` | Conversion start | +| | | | LVDS | ++--------------------+--------------------+------------+--------------------+ +| | ``cnv_en`` | ``output`` | Conversion enable, | +| | | | used as clear | +| | | | signal for the | +| | | | retiming flop from | +| | | | the chip (see | +| | | | schematic) | ++--------------------+--------------------+------------+--------------------+ +| | ``pd_cntrl`` | ``output`` | Powerdown control | +| | | | signal | ++--------------------+--------------------+------------+--------------------+ +| | ``testpat_cntrl`` | ``output`` | Enable for testing | +| | | | with a predefined | +| | | | pattern | ++--------------------+--------------------+------------+--------------------+ +| | ``twolanes_cntrl`` | ``output`` | Selection between | +| | | | one-lane mode and | +| | | | two-lane mode. | +| | | | Default it is 1 | ++--------------------+--------------------+------------+--------------------+ + +Clock Architecture +~~~~~~~~~~~~~~~~~~ + +The clock architecture of the CN0577 is designed with careful consideration to +ensure low jitter and low phase noise. + +An on-board 120 MHz voltage controlled crystal oscillator (VCXO) is used to +provide the clock for the CN0577 board and the FPGA. It is further named as +``reference clock``. This clock is gated and fed back to the device as the +``sampling clock``, on which the data was sampled. + +The DMA runs on the ZynqPS clock FCLK_CLK0 which has a frequency of 100 MHz. + +Digital Interface +~~~~~~~~~~~~~~~~~ + +The digital interface consists of the following signals: + +- ``ref_clk_*`` - LVDS clock input, used as reference clock for the system, + after it is converted to single-ended signal by ad_data_clk module +- ``clk_*`` - LVDS clock coming from the FPGA, that serially shifts out the + conversion result +- ``dco_*`` - LVDS clock input +- ``da_*`` - serial LVDS data input +- ``db_*`` - serial LVDS data input +- ``cnv_*`` - conversion start LVDS; a rising edge starts the conversion cycle +- ``cnv_en`` - signal that is used as CLR_N for the retiming flop from inside + the CN0577 board +- ``pd_cntrl`` - exposed on GPIO 33 +- ``testpat_cntrl`` - exposed on GPIO 32 +- ``twolanes_cntrl`` - hardcoded to 1 to always be used in two-lane mode + +ADC Timing Characteristics +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The timing considerations specified in the datasheet of the LTC2387-18 were +taken in consideration, and are implemented in the constraints file of the +project. + +What must be noted, is that the ``cnv_en`` signal must be constrained in order +to meet timing requirements for tCYC, tCONV, based on tFIRSTCLK and tLASTCLK. +``cnv_en`` being a CLR_N of the retiming flop, forces us to simulate the clock +of the retiming flop. + +In other words, a virtual clock is created, being a shadow of ``ref_clk_`` +(LVDS_CLK in schematic), and because it comes from the output of the **local +oscillator**, it needs to be shifted with the propagation delay that is given +from passing the **level translator**. Thus, it is shifted with 0.225 ns compared +to the ``ref_clk`` signal. + +Connector and Jumper Configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Depending on what configuration of pins is chosen on the jumpers P1, P2 and P3, +the device can act in different modes, as described below. The +PD_N and TESTPAT jumpers must be disconnected because the signals are tied to +GPIOs! By default, TWOLANES is set to 1 in HDL code! + +.. note:: Of course, the PD jumper overrides the PD signal from the FPGA. It is controlled by a one-bit-adc-dac in software. + +- P1 - configures PD_N + + - Shorting pins 1 and 2 -> PD_N = 1, device is not powered down + - Shorting pins 2 and 3 -> PD_N = 0, device is powered down + +- P2 - configures TESTPAT + + - Shorting pins 1 and 2 -> TESTPAT = 1, pattern testing is active + - Shorting pins 2 and 3 -> TESTPAT = 0, pattern testing is inactive + +- P3 - configures TWOLANES parameter + + - Shorting pins 1 and 2 -> TWOLANES = 1 (TWO LANES mode) + - Shorting pins 2 and 3 -> TWOLANES = 0 (ONE LANE mode) + +The FMC connector connects to the LPC connector of the carrier board. + +Software +-------- + +The software parts for this IP core can be found at: + +- `CN0577 Linux Kernel driver `_ +- `CN0577 Devicetree `_ + +Resources +--------- + +- HDL reference design: `CN0577 HDL project on GitHub `_ which uses :dokuwiki:`AXI_LTC2387 ` IP core +- Wiki page for :dokuwiki:`AXI_LTC2387 ` +- Schematic: :dokuwiki:`CN0577 schematic ` +- :dokuwiki:`HDL Architecture ` + + diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/block-assignments.csv b/docs/solutions/reference-designs/eval-cn0577-fmcz/block-assignments.csv new file mode 100644 index 00000000..17196f04 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/block-assignments.csv @@ -0,0 +1,13 @@ +Connector Name,Operation,Description,Settings/Ranges +P1,Power Down (PD) Mode,"When PD is high CN0577 will operate normally, but when PD is low CN0577 board enters power-down mode and all circuitry (including LVDS interface) is shutdown.",PD = High (Pins 1 and 2) +,,,PD = Low (Pins 2 and 3) +P2,Test Pattern (TESTPAT),"Forces the LVDS data outputs to be a test pattern. When TESTPAT is high digital outputs are a test pattern, and when TESTPAT is low digital outputs are the ADC conversion result.","TESTPAT = High (Pins 1 and 2) +TESTPAT = Low (Pins 2 and 3)" +P3,Lane Mode Selection,"The ADC outputs two bits at a time on DA-/DA+ and DB-/DB+ when two-lane output mode is high, and the ADC outputs one bit at a time on DA-/DA+ and DB-/DB+ when two-lane output mode is low.",TWOLANES = High (Pins 1 and 2) +,,,TWOLANES = Low (Pins 2 and 3) +P4,FMC Connector (LPC),Low pin count FMC connector used to connect the EVAL-CN0577-FMCZ hardware to various different FPGA development boards and kits.,N/A +J1,Positive Analog Input,"This is the positive input to the EVAL-CN0577-FMCZ, which connects to external signal sources via an SMA connection.",0V to 4.096 V +J2,Negative Analog Input,"This is the negative input to the EVAL-CN0577-FMCZ, which connects to external signal sources via an SMA connection.",0V to -4.096 V +J3,External Clock,If an external clocking source is desired in your system this is where you will need to connect it. Along with connecting it you will also need to update the solder jumper (JP14) to change from the onboard crystal oscillator.,On-board Crystal Oscillator (default 120 MHz) +JP14,,,External source (120 MHz desired) +,,, diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_1.jpg b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_1.jpg new file mode 100644 index 00000000..72eec632 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_1.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2914e59029c62cc67800ffb01f57d7c8e302cd834fd4eb48d692ea8f93cfb838 +size 75775 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_diag.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_diag.png new file mode 100644 index 00000000..5bf56912 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_diag.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:515531a885be41dfcdefe9c24fc184b53dd6f6e7aa03552befd41bd798d056c6 +size 108519 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_terminal.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_terminal.png new file mode 100644 index 00000000..065d4ed0 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_block_terminal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:35124572987a69248981839d501f3cdda9cb41a9124304a12bee56b0799792ca +size 464024 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_clock.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_clock.png new file mode 100644 index 00000000..19e1576d --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/cn0577_clock.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:20f708e8a95b2efbfe7b45f88f6686b3798443af38f436864651fd94f31fb909 +size 76948 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_ap.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_ap.png new file mode 100644 index 00000000..4375a979 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_ap.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f74838ca2e793aa6643ed4f3f296dd61a9983af490a7ed6a2c6fff52fe254ec +size 227623 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_m2k.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_m2k.png new file mode 100644 index 00000000..683ed5b0 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/demo_with_m2k.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a176bc7b36d33e88038c0686f82076cc53715734e8f28be5a9795453d0eec75f +size 258109 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/index.rst b/docs/solutions/reference-designs/eval-cn0577-fmcz/index.rst new file mode 100644 index 00000000..e03de369 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/index.rst @@ -0,0 +1,482 @@ + +EVAL-CN0577-FMCZ +===================== + +Overview +---------- + +Instrumentation applications such as flow cytometry, optical pulse +measurement, fast control loops, fast digital distortion correction, and image +sensor digitization present unique data acquisition challenges. These +applications often require a combination of high sample rate, high linearity, +low drift, low noise, and low latency. + +The :adi:`EVAL-CN0577-FMCZ ` is an 18-bit, 15 MSPS, 2 ppm linear data +acquisition system with an easy to drive input impedance of 1.1 kΩ. The analog +input range is 8.096 V peak-to-peak and can be driven in either single-ended +or differential mode, providing flexibility for many different applications. + +The circuit is in field programmable gate array (FPGA) mezzanine card (FMC) +form factor, powered with 12 V either from the FMC connector or an external +supply. The digital interface uses serial low voltage differential signaling +(LVDS), minimizing the input/output requirements and enabling easy integration +with other FPGA designs + +A separate data clock eases the timing requirements of the host FPGA. An +on-board 120 MHz clock is forwarded to the FPGA and a CONVERT retiming +flip-flop reduces jitter from the convert signal of the FPGA. + + + +.. image:: cn0577_1.jpg + :width: 600 px + + + +Simplified Functional Block Diagram +------------------------------------- + +.. image:: cn0577_block_diag.png + + + +Features +-------- + +- 15 MSPS Throughput Rate +- Guaranteed 18-Bit, No Missing Codes +- No Pipeline Delay, No Cycle Latency +- 96 dB SNR (Typical) +- 164.5 dB dynamic range +- 2 ppm INL (Typical) +- Serial LVDS Digital Interface +- Flexible analog input drive (single-ended or differential mode) +- On-board 120 MHz precision voltage-controlled crystal oscillator (VCXO) + + +Hardware Configuration +---------------------- + + +Block Assignments +~~~~~~~~~~~~~~~~~~~ + +.. image:: cn0577_block_terminal.png + +.. csv-table:: + :file: block-assignments.csv + + +Power Supply +~~~~~~~~~~~~~ + +Power to the :adi:`EVAL-CN0577-FMCZ ` comes directly from the ++12 V supply provided through the FMC connector. + +.. image:: power_supply_1.png + + +Analog Inputs +~~~~~~~~~~~~~~~~ + +The SMA connectors on the :adi:`EVAL-CN0577-FMCZ ` (VIN+ +and VIN−) provide analog inputs from a low noise, audio precision signal +source (such as the Audio Precision audio analyzer). + + +On-board Clock Reference +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :adi:`EVAL-CN0577-FMCZ ` clock diagram is shown in the figure below. +An on-board 120 MHz voltage controlled crystal oscillator is used to provide +the clock for the :adi:`EVAL-CN0577-FMCZ ` and the FPGA. This +ultralow noise oscillator has a typical phase noise of -162 dBc/Hz at 10 kHz +offset, a tuning voltage range of 0 V to 3.3 V, and a frequency pulling range of +28 ppm to 55 ppm. Additionally, this crystal oscillator has an RMS jitter of <50 +fs to 100 fs at 100 MHz carrier. + +The clock is fanned out to the retiming flip-flop and the FPGA. An +:adi:`ADG3241` level shifter converts the clock’s 3.3 V logic level +to the 2.5 V level required by the retiming flip-flop. An +:adi:`ADN4661` converts the 3.3 V clock to LVDS signaling, which is +then forwarded to a global clock connection on the FMC connector. + +.. image:: cn0577_clock.png + + +External Clock Reference Option +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If the :adi:`EVAL-CN0577-FMCZ ` is to be synchronized to +other circuits, or if tighter frequency accuracy or drift frequency drift is +required, an external clock can be applied to the external clock connector +(J3). Along with connecting it, you will also need to update the solder jumper +(JP14) to change from the onboard crystal oscillator. If the external clock +frequency is significantly higher or lower than the on-board 120 MHz clock, +reanalyze the entire circuit including the FPGA timing constraints. + +.. image:: jp14.png + :width: 300 px + +The external clock circuitry also includes a high speed single inverter that +provides AC coupling and balances the rise and fall times. This device has a +typical time propagation delay of 2.4 ns and achieves a high output drive, +while maintaining low static power dissipation over a broad VCC operating +range. + + +System Setup +~~~~~~~~~~~~~~~~~ + +Demo Requirements +~~~~~~~~~~~~~~~~~ + +The following is the list of items needed in order to replicate this demo. + +Hardware +^^^^^^^^ + +- :adi:`EVAL-CN0577-FMCZ ` Circuit Evaluation Board +- ZedBoard (AES-Z7EV-7Z020-G) +- 12 V power supply +- Host PC +- SD card (16 GB or larger) +- LAN cable +- SMA cables +- XLR to SMA adapter cable +- Audio analyzer (Audio Precision© APX525) or other input source (e.g., ADALM2000) + +If using :adi:`ADALM2000`` as input source: + +- :adi:`AD-M2KBNC-EBZ` +- BNC to SMA cable + + +Software +^^^^^^^^ +- :dokuwiki:`Analog Devices Kuiper Linux image ` + +For the device to run, the SD card should be loaded with Analog Devices Kuiper +Linux, a distribution based on Raspbian from the Raspberry Pi Foundation. It +incorporates Linux device drivers for ADI products as well as tools and other +software products designed and created with ease of use in mind. The reasoning +behind creating this distribution is to minimize the barriers to +integrating ADI hardware devices into a Linux-based embedded system. + +Access to the embedded system can be through a remote PC connected either via +LAN cable or Wi-Fi. + +Loading Image on SD Card +~~~~~~~~~~~~~~~~~~~~~~~~ + +In order to control the :adi:`EVAL-CN0577-FMCZ `, you will +need to install ADI Kuiper Linux on an SD card. Complete instructions, including +where to download the SD card image, how to write it to the SD card, and how to +configure the system are provided at :dokuwiki:`Kuiper Images `. Write the +image and follow the system configuration procedure. Follow the directions for +preparing the image for the CN0577. + + +SD Card +~~~~~~~ + +To prepare the SD card for the Zedboard: + +#. `Download ADI Kuiper Image for CN0540 `__ + +#. Validate, Format, and Flash the SD Card + * :dokuwiki:`Format and flash the SD Card using Windows ` + * :dokuwiki:`Format and flash the SD Card using Linux ` + +#. Configuring the SD Card. Follow instructions for Xilinx projects. + + * Directory on SD image: cn0577_zed + * Image files on SD card: zynq-common + + + +System Block Diagram +---------------------- + +.. image:: sys_block_diag.png + + + +Running the System +~~~~~~~~~~~~~~~~~~ + +To set up the complete system using **Audio Precision audio analyzer** as input +source, follow these steps: + +#. Download and install the IIO Oscilloscope application on the PC, Mac, or + Linux host. +#. Load the Analog Devices Kuiper Linux image onto the SD card. +#. Configure the SD card for the :adi:`EVAL-CN0577-FMCZ `. +#. Place the SD card into the ZedBoard. +#. Connect :adi:`EVAL-CN0577-FMCZ ` to the ZedBoard through + the FMC pin connector. +#. Connect the 12 V power supply jack on the ZedBoard. +#. Plug in the LAN cable from the ZedBoard to the host computer. +#. Connect the :adi:`EVAL-CN0577-FMCZ ` to the Audio + Precision audio analyzer using the XLR to SMA adapter cable. +#. Connect the ground of the :adi:`EVAL-CN0577-FMCZ ` to the + Audio Precision audio analyzer. +#. Connect the Audio Precision audio analyzer USB cable to PC. +#. Run the IIO Oscilloscope software and capture the resulting ADC data. + + +.. image:: demo_with_ap.png + + +Using :adi:`ADALM2000` as input source: + +#. Download and install the IIO Oscilloscope application on the PC, Mac, or + Linux host. +#. Load the Analog Devices Kuiper Linux image onto the SD card. +#. Configure the SD card for the :adi:`EVAL-CN0577-FMCZ `. +#. Place the SD card into the ZedBoard. +#. Connect :adi:`EVAL-CN0577-FMCZ ` to the ZedBoard through + the FMC pin connector. +#. Connect the 12 V power supply jack on the ZedBoard. +#. Plug in the LAN cable from the ZedBoard to the host computer. +#. Connect the :adi:`AD-M2KBNC-EBZ` to the ADALM2000. +#. Connect the ADALM2000 to :adi:`EVAL-CN0577-FMCZ ` using + BNC to SMA cable (W1 to J1 and W2 to J2) +#. Plug the ADALM2000 to the host PC. Open Scopy and use the Signal Generator + feature to set input. More information on using the Scopy Signal Generator in :dokuwiki:`here `. +#. Run the IIO Oscilloscope software and capture the resulting ADC data. + +.. image:: demo_with_m2k.png + + + +Software +-------- + +The :adi:`EVAL-CN0577-FMCZ ` is supported with the Libiio +library. This library is cross-platform (Windows, Linux, Mac) with language +bindings for C, C#, Python, MATLAB, and others. Two easy to examples that can be +used with the :adi:`EVAL-CN0577-FMCZ ` are: + +- :dokuwiki:`IIO Oscilloscope ` +- :dokuwiki:`Python (via Pyadi-iio) ` + +Connection +~~~~~~~~~~ + +To be able to connect your device, the software must be able to create a +context. The context creation in the software depends on the backend used to +connect to the device as well as the platform where the EVAL-CN0577-FMCZ is +attached. The platform currently supported for the CN0557: ZedBoard using the +ADI Kuiper Linux. The user needs to supply a URI which will be used in the +context creation. The Libiio is a library for interfacing with IIO devices. + +Install the `Libiio package `__ on your +machine. + +The :dokuwiki:`iio_info ` +command is a part of the libIIO package that reports all IIO attributes. + +Upon installation, simply enter the command on the terminal command line to +access it. + + + +For Windows machine connected to ZedBoard via Ethernet cable: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Using SSH Terminal Software: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Open SSH Terminal Software (PuTTY, TeraTerm or similar). User should now start +the PuTTY application and enter certain values in the configuration window. In +the terminal, run: + +:: + + analog@analog:~$ iio_info -u ip: + + +Using Command Terminal: +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:: + + iio_info -s + +Prompting this on the command terminal in your windows PC will give you the ip +address to access the EVAL-CN0577-FMCZ. + +:: + + ssh analog@ + +:: + + analog@analog:~$ iio_info -u ip: + +| + +IIO Commands +~~~~~~~~~~~~ + +There are different commands that can be used to manage the device being used. +The :dokuwiki:`iio_attr ` +command reads and writes IIO attributes. + +:: + + analog@analog:~$ iio_attr [OPTION]... + +Example: + +:: + + * To look at the context attributes, enter this code on the terminal: + +:: + + analog@analog:~$ iio_attr -a -C + +| + +IIO Oscilloscope +~~~~~~~~~~~~~~~~~ + + + .. admonition:: Download + + Make sure to download/update to the latest version of IIO Oscilloscope. + `https://github.com/analogdevicesinc/iio-oscilloscope/releases`_ + + +#. Once done with the installation or an update of the latest IIO Oscilloscope, + open the application. The user needs to supply a URI which will be used in + the context creation of the IIO Oscilloscope and the instructions can be seen + from the previous section. +#. Press refresh to display available IIO Devices, once ltc2387 appeared, press + connect. + +.. image:: 577_osc.png + + +Debug Panel +^^^^^^^^^^^ + +Below is the Debug panel of ltc2387 wherein you can directly access the +attributes of the device. + +.. image:: 577_debug_panel.png + + + +DMM Panel +^^^^^^^^^ + +Access the DMM panel to see the instantaneous reading of the ADC voltages and +the device temperature. + +.. image::577_dmm_panel.png + + + +Pyadi-IIO +~~~~~~~~~ + +:dokuwiki:`PyADI-IIO ` is a python +abstraction module for ADI hardware with IIO drivers to make them easier to +use. This module provides device-specific APIs built on top of the current +libIIO python bindings. These interfaces try to match the driver naming as +much as possible without the need to understand the complexities of libIIO and +IIO. + + +Running the Example +^^^^^^^^^^^^^^^^^^^ + +After installing and configuring PYADI-IIO in your machine, you are now ready to +run python script examples. In our case, run the ltc2387_example.py found in the +examples folder. + +#. Connect the :adi:`EVAL-CN0577-FMCZ ` to the ZedBoard. +#. Open command prompt or terminal and navigate through the examples folder + inside the downloaded or cloned *pyadi-iio* directory. +#. Run the example script using the command. + +:: + + .../pyadi-iio/examples $ python3 ltc2387_example.py + +Running example with ADALM2000 with the setting below: + +.. image:: scopy_diff_input.png + +The expected output should look like this: + +.. image:: output_time_domain.png + + +GitHub link for the python sample script: `CN0577 Python Example `__ + + + +Schematic, PCB Layout, Bill of Materials +---------------------------------------- + +.. admonition:: Download + + `EVAL-CN0577-FMCZ Design & Integration Files ` + + - Schematics + - PCB Layout + - Bill of Materials + - Allegro Project + - LTspice Simulation File + + +Reference Demos & Software +---------------------------- + +- `pyADI-IIO `__ +- :dokuwiki:`PyADI-IIO Installation Guide ` +- :dokuwiki:`IIO Oscilloscope Installation Guide ` +- :dokuwiki:`Kuiper Images ` +- :dokuwiki:`CN0577 HDL Reference Design ` + + + +More Information and Useful Links +----------------------------------- + +- :adi:`CN0577 Circuit Note Page ` +- :adi:`LTC2387-18 Product Page ` +- :adi:`ADR4520 Product Page ` +- :adi:`ADA4945-1 Product Page ` +- :adi:`ADN4661 Product Page ` +- :adi:`ADG3241 Product Page ` +- :adi:`LT3042 Product Page ` +- :adi:`LT3080 Product Page ` +- :adi:`LT3094 Product Page ` +- :adi:`LT1931 Product Page ` + + + +Registration +------------ + +Receive software update notifications, documentation +updates, view the latest videos, and more when you register your hardware. +`Register `__ to receive all these great benefits +and more! + +--------------------------------------------------------------------------------------------------------------------------------------------- +Up Next... + + +.. toctree:: + :titlesonly: + :maxdepth: 1 + :glob: + + */index + diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/jp14.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/jp14.png new file mode 100644 index 00000000..446e9120 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/jp14.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:af5d7b3d3255ca175dcc775c3af87bc812e5cba909bfdfa103a95445e9cc3bee +size 553867 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/output_time_domain.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/output_time_domain.png new file mode 100644 index 00000000..7e51aa7e --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/output_time_domain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ae5e93d6ed93a825aff9871294dc77b52df403823ad11883bf9d40e9372563ba +size 45989 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/power_supply_1.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/power_supply_1.png new file mode 100644 index 00000000..896693e4 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/power_supply_1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7123d5a49a7ae6dd81a8b266a72906c111d07bb90e504b6bf8f904e107f01aaf +size 262815 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/scopy_diff_input.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/scopy_diff_input.png new file mode 100644 index 00000000..fc82be28 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/scopy_diff_input.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:01ac8f5ae4b3c7352924302c7e61a791b99b6d626546597df299b78279b62003 +size 91638 diff --git a/docs/solutions/reference-designs/eval-cn0577-fmcz/sys_block_diag.png b/docs/solutions/reference-designs/eval-cn0577-fmcz/sys_block_diag.png new file mode 100644 index 00000000..bed0b63e --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0577-fmcz/sys_block_diag.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a91a85cb686fffc76e0906529433bb5a2126a85ea1e9fa2a8150de48c1c8f4cc +size 12949 diff --git a/docs/solutions/reference-designs/eval-isomax/EVAL-ISOMAX-design_support.zip b/docs/solutions/reference-designs/eval-isomax/EVAL-ISOMAX-design_support.zip new file mode 100644 index 00000000..b1ed7752 Binary files /dev/null and b/docs/solutions/reference-designs/eval-isomax/EVAL-ISOMAX-design_support.zip differ diff --git a/docs/solutions/reference-designs/eval-isomax/adbms2950_with_isomax_and_sdp-k1.png b/docs/solutions/reference-designs/eval-isomax/adbms2950_with_isomax_and_sdp-k1.png new file mode 100644 index 00000000..fbe40dc2 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/adbms2950_with_isomax_and_sdp-k1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1542a611674955f9f67edab45b95ff7a2a3225f1037ad3eec278c361fd3870b5 +size 67132 diff --git a/docs/solutions/reference-designs/eval-isomax/eval-isomax_angle.jpg b/docs/solutions/reference-designs/eval-isomax/eval-isomax_angle.jpg new file mode 100644 index 00000000..031325d2 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/eval-isomax_angle.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa2fa58da731b81fef82612b7a426dfaa5384f7c5eb0c1846fd99e26e7af93a6 +size 67182 diff --git a/docs/solutions/reference-designs/eval-isomax/eval-isomax_block_diagram.png b/docs/solutions/reference-designs/eval-isomax/eval-isomax_block_diagram.png new file mode 100644 index 00000000..bdac3f33 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/eval-isomax_block_diagram.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a4ddb6f81799b5eaa642786c4fc8d1d311ff00a30925b68af703486bada9a8f6 +size 39377 diff --git a/docs/solutions/reference-designs/eval-isomax/eval-isomax_package_contents.png b/docs/solutions/reference-designs/eval-isomax/eval-isomax_package_contents.png new file mode 100644 index 00000000..4b12673c --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/eval-isomax_package_contents.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:43e54b259673d8da891356a88c0078e961ce1cc27b93fa9384590714d70186b2 +size 408769 diff --git a/docs/solutions/reference-designs/eval-isomax/eval-isomax_with_ad-apard32690-sl.png b/docs/solutions/reference-designs/eval-isomax/eval-isomax_with_ad-apard32690-sl.png new file mode 100644 index 00000000..c3c49f70 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/eval-isomax_with_ad-apard32690-sl.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfcc14087668e0921115389e247c2f1dfe16b2bbeec1b0d9ab8dfad0eddecf63 +size 52546 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/2950_launch.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/2950_launch.png new file mode 100644 index 00000000..bcb5d045 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/2950_launch.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f1fae2ff5fc1273b3fff13afb779d09df4ad3dca4e864493b0a8133bd441a88a +size 43949 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/EVAL-ISOMAX-design_support.zip b/docs/solutions/reference-designs/eval-isomax/hardware_guide/EVAL-ISOMAX-design_support.zip new file mode 100644 index 00000000..b1ed7752 Binary files /dev/null and b/docs/solutions/reference-designs/eval-isomax/hardware_guide/EVAL-ISOMAX-design_support.zip differ diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/adbms2950_with_isomax_and_apard.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/adbms2950_with_isomax_and_apard.png new file mode 100644 index 00000000..5132b7a7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/adbms2950_with_isomax_and_apard.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:21ef13f7ea65271be645a0101a78dac60b070ca9b41b028c04c3034ac73144c4 +size 44838 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_launch.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_launch.png new file mode 100644 index 00000000..0cb8a013 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_launch.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0e379696db909b47e3f7dac22854c2eefae56f19c6edfb32e3c933538f25810a +size 133884 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_plot_all_devices.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_plot_all_devices.png new file mode 100644 index 00000000..a0ff6c0d --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_plot_all_devices.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5b9cf3f8fbf8f77b7ce5fa6afc1f4aa6c93f23281e46cfd99b01ec1bf9ae4ffc +size 99957 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_start_measure.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_start_measure.png new file mode 100644 index 00000000..e84def5b --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/browser_start_measure.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1f8bf6aef549603e51b910e45839512c294f08c8224c428354ce07edf3104b02 +size 101370 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/copying_the_eval-isomax_folder.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/copying_the_eval-isomax_folder.png new file mode 100644 index 00000000..d18bae2b --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/copying_the_eval-isomax_folder.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5e660baac32193206e817fb1d28615ca28745146982054a65451784098846a2 +size 49085 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_launch.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_launch.png new file mode 100644 index 00000000..fbadf0c9 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_launch.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3c5a23ab112af1c8532b5d1aa41c4f37bdb24ee431176929504c93230d31a5c2 +size 45193 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_memory_map.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_memory_map.png new file mode 100644 index 00000000..88f102a5 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_memory_map.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8417cd048363d64f5c5628ab211ae6bd1a4f4488e08d8d4f6908e6d3a8fb1336 +size 124885 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot1.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot1.png new file mode 100644 index 00000000..9f246c67 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5865f57d831f8c295bc264a5159129f90ae3614edfb34793725d1ba06a5ba9bf +size 93288 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot2.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot2.png new file mode 100644 index 00000000..04b87f6b --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:eaa0b2e9ecbb1109e8dc7d1d1b08e879b06be66027a2265617317c02e5c0be98 +size 262364 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot3.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot3.png new file mode 100644 index 00000000..5f56fa1f --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_plot3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c025771bc175360db32b59116717ba1edd1b6970f47e0dffb0b830bf5a0717fe +size 120669 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_sequences.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_sequences.png new file mode 100644 index 00000000..aaffdb9a --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisy_chain_sequences.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:71183c39125e57be606d747b69618770b351f4820776668fb67f33e863fd6d32 +size 48421 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisychain_with_isomax_and_apard.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisychain_with_isomax_and_apard.png new file mode 100644 index 00000000..4b95dfed --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/daisychain_with_isomax_and_apard.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0b9a2aacc3a4e393cf22be6fdbee507f62cc6584030f98ac5f485be1c831637b +size 45741 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_angle.jpg b/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_angle.jpg new file mode 100644 index 00000000..92cfeae8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_angle.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ed2c958a7b8be195f309014f50fab80c0c7bac4f6c6bfe1c43cbd0d2cf80bce +size 122541 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_folder_contents.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_folder_contents.png new file mode 100644 index 00000000..49122bc9 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/eval-isomax_folder_contents.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:724bdb7735cb237e0e5f29f8f60eb9e84802312e6ee1b6308e620343f7ef6dd4 +size 11937 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/idle_current.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/idle_current.png new file mode 100644 index 00000000..aa5c1e2c --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/idle_current.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a1348dc3acf8d104363bd9644bdaea4591f5bb8a92d4084cc4667be022ec10f5 +size 761113 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/index.rst b/docs/solutions/reference-designs/eval-isomax/hardware_guide/index.rst new file mode 100644 index 00000000..0a179cea --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/index.rst @@ -0,0 +1,571 @@ +Hardware User Guide +========================== + +Overview +-------- + +The :adi:`EVAL-ISOMAX` is an integrated dual isoSPI adapter and microcontroller +board featuring the MAX32670 high-reliability, ultralow power microcontroller +and the ADBMS6822 dual isoSPI transceiver. This board allows multiple ADBMS68xx +battery monitors to be connected through daisy-chain configuration. + +The EVAL-ISOMAX 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. + + + +Hardware Setup when using EVAL-ISOMAX as a Standalone MCU with Other BMS Boards +------------------------------------------------------------------------------- + +This section describes the procedure for establishing hardware connection +between the EVAL-ISOMAX and other ADI Broad Market BMS boards, how to download +the software files such as the firmware and GUI installer, and eventually obtain +and view BMS readings through the BMS graphical user interface. + +Before you proceed with the system setup, make sure you have the following: + + +Equipment Needed +--------------------- + +**Boards** + + * ► 1x :adi:`EVAL-ISOMAX` Dual isoSPI Adapter and Microcontroller Board + * ► 2x :adi:`EVAL-ADBMS6830BMSW` 16-Channel Battery Cell Monitor + * ► 1x :adi:`EVAL-ADBMS2950-BASIC` Battery Pack Monitor + * ► 2x :adi:`DC2472A` Battery Cell Emulator + * ► 1x :adi:`MAX32625PICO` Programming Adapter with 10-pin SWD cable + +**Cables and Other Equipment** + + * ► 2x Cell Connector Block (18-cell connector) + * ► 3x DuraClik isoSPI Twisted Pair Cables + * ► 3x USB Type A to Micro-B Cable + * ► 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) + + +Software Needed +-------------------- + +The BMS Broadmarket Browser GUI is a PC browser-based graphical user interface (GUI) tool designed to work in conjunction with the ADI Broad Market BMS devices. + +**MyAnalog.com account is required in downloading the BMS Browser GUI** from below link: + + +:adi:`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. + + + +Programming the MCU using the MAX32625PICO Adapter +---------------------------------------------------------- + +This procedure is required to be done before connecting other BMS boards to the EVAL-ISOMAX. + +Make sure that you have downloaded and installed the BMS Browser GUI to the host +PC before programming the MCU. + +**Follow these steps if the EVAL-ISOMAX is used as a standalone MCU:** + +#. Download the firmware image: `MAX32625PICO Firmware Image for MAX32670 MCU max32625pico-firmware-images/raw/master/bin/max32625_max32670evkit_if_crc_swd_v1.0.3.bin`__ +#. Connect the MAX32625PICO to the Host PC using the microUSB to USB cable. +#. Press the button on the MAX32625PICO. **(Do not release the button until the MAINTENANCE drive is mounted)**. +#. Release the button once the MAINTENANCE drive is mounted. +#. Drag and drop the firmware image into the MAINTENANCE drive. +#. 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. +#. Connect the MAX32625PICO to the EVAL-ISOMAX using the 10-pin SWD ribbon cable. +#. Connect the EVAL-ISOMAX to the Host PC using a USB cable. +#. A DAPLINK drive should appear in Windows Explorer. + + + +Uploading the EVAL-ISOMAX Firmware into the Broadmarket BMS Browser GUI Installer +---------------------------------------------------------------------------------------- + +#. Download and extract the **EVAL-ISOMAX folder** in the host PC. +#. Copy and paste the entire **EVAL-ISOMAX folder** into the + USB_TO_SPI directory inside the Broadmarket BMS GUI installation folder. + **Location: C:\\Analog Devices\\BMS_Browser_GUI_Broadmarket-Rel2.0.0\\USB_TO_SPI_Firmware** + + .. image:: copying_the_eval-isomax_folder.png + +#. Make sure that the copied folder contains the **isomax32670-usb-to-spi.hex** file. + + .. image:: eval-isomax_folder_contents.png + +#. The EVAL-ISOMAX board is now ready to be used with the Broadmarket BMS + Browser GUI. Refer to the next sections for procedure on how to set up the + hardware for evaluation. + + +Battery Cell Monitoring (EVAL-ISOMAX + EVAL-ADBMS6830BMSW) +---------------------------------------------------------- + +Hardware Connection +~~~~~~~~~~~~~~~~~~~ + +The DC2472A Battery Emulator Board is used for cell voltage input in this setup. +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. + +.. image:: isomax_6830.png + + +#. Plug the screw-terminal block into the cell voltage connector 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). +#. Connect a 5 V external power source to the DC2472A (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. + +#. Connect the EVAL-ISOMAX (P6) 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 micro-USB to USB cable into P15 of the EVAL-ISOMAX. Connect the other end to a PC/Laptop. DS3 (Green), DS2 (Red), and DS5 (Red) LEDs should light up indicating a default power up. +#. Connect the 10-pin SWD debugger cable to port P12 of the EVAL-ISOMAX. Connect the other end of the SWD debugger cable to the MAX32625PICO. Observe correct polarity when connecting the SWD cable. +#. Use the micro-USB to USB cable to connect the MAX32625PICO to the PC/Laptop. + + + +Testing the Setup +~~~~~~~~~~~~~~~~~ + +#. Open the BMS Browser GUI. +#. In the **Interface Connection** section, select the COM port associated + with the EVAL-ISOMAX. +#. Under the **Daisy Chain** section, ensure that the **Generation** drop + down 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. **Other Settings** can remain as + default. +#. Click **Launch**. + + .. image:: browser_launch.png + +#. 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. + + .. image:: browser_start_measure.png + +#. Check the Total PEC Status on the 3rd row under the Memory Map. This + indicates the status of the isoSPI link between the EVAL-ISOMAX and the + EVAL-ADBMS6830BMSW. + * Ensure the EVAL-ADBMS6830BMSW board is powered correctly, indicated by the Blue LED on the DC2472A emulator board being illuminated. + * Verify the connection of the twisted cable between the EVAL-ISOMAX 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 (EVAL-ISOMAX + EVAL-ADBMS2950-BASIC) +------------------------------------------------------------ + +Hardware Connection +~~~~~~~~~~~~~~~~~~~ + +#. Connect the EVAL-ISOMAX (P6) to the EVAL-ADBMS2950-BASIC (isoA) using the + provided twisted-pair DuraClik cable + + .. image:: isomax_2950.png + +#. Choose between two options for powering the EVAL-ADBMS2950-BASIC: + * Using an external power source, supply 5 V (via J1) and set the current limit to 200 mA. The EVAL-ADBMS2950-BASIC consumes <50 mA in idle mode and ~100 mA in active mode. + * Alternatively, power the board using a micro-USB cable connected to J10. +#. Attach the MAX32625PICO programmer to the EVAL-ISOMAX using the 10-pin ribbon SWD cable. Observe correct polarity when connecting the SWD cable. +#. Connect one end of the USB cable to EVAL-ISOMAX (P15) and the other end to the host PC. + + + +Testing the Setup +~~~~~~~~~~~~~~~~~ + +#. Open the BMS Browser GUI. +#. Go to the **Interface Connection** section and select the COM port + associated with the EVAL-ISOMAX. +#. Under the **Daisy Chain** section, ensure the Generation drop-down box is + set to **ADBMSGEN6**. +#. 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. +#. Click **Launch**. + + .. image:: 2950_launch.png + +#. 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. +#. Check the Total PEC Status on the Memory Map. It should reflect **true**, + indicating a successful isoSPI link between the EVAL-ISOMAX and the + EVAL-ADBMS2950-BASIC. If false, there is an error in the signal chain. + + + +Complete Daisy Chain +-------------------- + +Once familiar with the setup for each of the individual boards the entire signal +chain can be verified. + +Hardware Connection +~~~~~~~~~~~~~~~~~~~ + +#. Connect the hardware using the DuraClik isoSPI cables, as shown in the + diagram below. + + .. image:: isomax_daisy_chain.png + +#. Power each DC2472A using a 5V 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 EVAL-ISOMAX using the 10-pin ribbon + SWD cable. Observe correct polarity when connecting the SWD cable. +#. Connect one end of the USB cable to EVAL-ISOMAX (P2) and the other end to the + host PC. + +Testing the Setup +~~~~~~~~~~~~~~~~~~~~~~~~ + +#. Launch the BMS Browser GUI following the previous instructions and choose the + appropriate **COM port** associated to the EVAL-ISOMAX. +#. 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. 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. + + .. image:: daisy_chain_launch.png + +#. Click on the **Launch** button to initiate the GUI. After the GUI + launches in the browser, go to the **Sequences** tab located in the top + toolbar, this will open the **Sequence Configuration** page. + + .. image:: daisy_chain_sequences.png + +#. Under **Files**, select **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. + + .. image:: daisy_chain_memory_map.png + +#. The **Plots** tab allows for the visualization of parameters recorded during the command loop. It supports the creation of up to four plots simultaneously. + 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:: daisy_chain_plot1.png + + + .. image:: daisy_chain_plot2.png + + + .. image:: daisy_chain_plot3.png + +#. Plot settings can be saved to the PC to be reloaded for future session to save time. + + + + +Hardware Setup when using EVAL-ISOMAX as a Secondary Device to Other MCU Boards +---------------------------------------------------------------------------------- + +This section describes how to configure EVAL-ISOMAX as a secondary device to +another MCU board such as the AD-APARD32690-SL and SDP-K1 and use it with other +ADI Broad Market BMS board for evaluation. + +Before you proceed with the system setup, make sure you have the following: + + +Equipment Needed +~~~~~~~~~~~~~~~~~~~~~ + +**Boards** + + * ► 1x Microcontroller Board (such as the :adi:`AD-APARD32690-SL` or :adi:`SDP-K1`) + * ► 1x EVAL-ISOMAX Dual isoSPI Adapter and Microcontroller Board + * ► 2x EVAL-ADBMS6830BMSW 16-Channel Battery Cell Monitor + * ► 1x EVAL-ADBMS2950-BASIC Battery Pack Monitor + * ► 2x DC2472A Battery Cell Emulator + * ► 1x MAX32625PICO Programming Adapter with 10-pin SWD cable + +**Cables and Other Equipment** + + * ► 2x Cell Connector Block (18-cell connector) + * ► 3x DuraClik isoSPI Twisted Pair Cables + * ► 3x USB Type A to Micro-B Cable + * ► 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) + + +**Software Needed** + +The BMS Browser is a PC browser based Graphical User Interface (GUI) tool designed to work in conjunction with the Broad Market BMS devices. + +**MyAnalog.com account is required in downloading the BMS Browser GUI** from below link: + +:adi:`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. + + +MCU Configuration +------------------------ + +This procedure is required to be done before +connecting other BMS boards to the EVAL-ISOMAX. + +Make sure that you have downloaded and installed the BMS Browser GUI to the host +PC before programming the MCU. + + +Follow these instructions if :adi:`AD-APARD32690-SL` is used as the main controller board: + +#. Download the firmware image: `MAX32625PICO Firmware Image for MAX32690 MCU max32625pico-firmware-images/raw/master/bin/max32625_max32690evkit_if_crc_swd_v1.0.7.bin`__ +#. Connect the MAX32625PICO to the Host PC using the microUSB to USB cable. +#. Press the button on the MAX32625PICO. **(Do not release the button until the MAINTENANCE drive is mounted)** +#. Release the button once the MAINTENANCE drive is mounted. +#. Drag and drop the firmware image to the MAINTENANCE drive. +#. 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. +#. Connect the MAX32625PICO to the AD-APARD32690-SL using the 10-pin SWD ribbon + cable. +#. Connect the AD-APARD32690-SL to the Host PC using a USB cable. +#. A DAPLINK drive should appear in Windows Explorer. +#. Locate the firmware HEX file to be programmed on the MCU board in the installation folder of the BMS Browser GUI Broadmarket. Location: **C:\\Analog + Devices\\BMS_Browser_GUI_Broadmarket-Rel2.0.0\\USB_TO_SPI_Firmware** +#. Drag and drop the **usb-to-spi-max32690.hex** file to the DAPLINK drive to flash the firmware needed by the BMS Browser GUI. +#. A normal copy progress dialog will appear. Once the progress bar is completed, the dialog window will close, and the DAPLINK drive will reconnect. +#. Check the DAPLINK directory and make sure there is no **FAIL.TXT** file. In case there is, repeat the drag and drop step. Otherwise, the MAX32625PICO can now be disconnected from the AD-APARD32690-SL, since the firmware update is complete. + + +Follow these steps if :adi:`SDP-K1` is used as the main controller board: + +#. Connect the SDP-K1 microcontroller board to the host PC using a USB cable. +#. Locate the firmware HEX file to be programmed on the MCU board in the + installation folder of the BMS Browser GUI Broadmarket. + Location: **C:\\Analog + Devices\\BMS_Browser_GUI_Broadmarket-Rel2.0.0\\USB_TO_SPI_Firmware** +#. Drag and drop the **SDP_K1_PyBMS_USB_TO_SPI_Bytes_Debug_USB_Port.hex** file + onto the corresponding SDP-K1 drive to update the firmware. + + + +Battery Cell Monitoring +----------------------- + +Hardware Connection +~~~~~~~~~~~~~~~~~~~ + +.. image:: using_isomax_as_a_secondary_device_to_other_mcu.png + +The DC2472A Battery Emulator Board is used for cell voltage input in this setup. +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 :dokuwiki:`EVAL-ADBMS6830BMSW User Guide ` for procedure on +connecting resistors. + +#. **Battery Emulator Board Setup:** + * Use the DC2472A Battery Emulator Board for cell voltage input. + * Alternatively, use 100 Ω ½ W resistors to simulate battery cell voltages. Refer to the EVAL-ADBMS6830BMSW User Guide for resistor connection procedures. +#. **Connecting the Emulator Board:** + * Plug the screw-terminal block into the cell voltage connector of the DC2472A. + * Leave the last three terminals of the DC2472A hanging. + * Connect the DC2472A to the EVAL-ADBMS6830BMSW via the cell voltage connectors (J1). +#. **Powering the Emulator Board:** + * Connect a 5V external power source to the DC2472A (J1) using a USB cable. External power supply is recommended for adequate power. + * Alternatively, power it through a PC using a USB cable connected via J10. +#. **Connecting the EVAL-ISOMAX:** + * Attach the EVAL-ISOMAX to the AD-APARD32690-SL (or SDP-K1) through the Arduino Headers. + * Connect the EVAL-ISOMAX (P6) to the EVAL-ADBMS6830BMSW (J3) using a 2-wire twisted-pair patch cable. +#. **Configuring Jumpers:** + * On the EVAL-ISOMAX, set Jumpers P16, P17, and P18 to position 2 and 3 to use power from the main MCU. +#. **Connecting to PC:** + * Plug the micro-USB to USB cable into the AD-APARD32690-SL (or SDP-K1). + * Connect the other end to a PC/Laptop. + * Ensure DS3 (Green), DS2 (Red), and DS5 (Red) LEDs light up, indicating a default power up. +#. **Connecting the Debugger:** + * Connect the 10-pin SWD debugger cable to the AD-APARD32690-SL (or SDP-K1). + * Connect the other end of the SWD debugger to the MAX32625PICO. + + + +Testing the Setup +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +#. **Open the BMS Browser GUI**. +#. **Select the COM Port**: + * In the Interface Connection section, choose the COM port associated with the AD-APARD32690-SL (or SDP-K1). +#. **Configure Daisy Chain**: + * Set the Generation drop-down box to **ADBMSGEN6**. + * From the Products list, select **ADBMS6830** and add it to the Daisy Chain. +#. **Launch the GUI**: + * Click **Launch**. + * The **Quick Measure** tab will open. Note: This utility supports only a single BMS product in a Daisy Chain. + * Click **Start Quick Measure** to begin measurements. +#. **Check Connections and Status**: + * Verify the Total PEC Status on the 3rd row under the Memory Map to checkthe isoSPI link status between the EVAL-ISOMAX and the EVAL-ADBMS6830BMSW. + * Ensure the EVAL-ADBMS6830BMSW board is powered correctly (Blue LED on the DC2472A should be illuminated). + * Verify the connection of the twisted cable between the EVAL-ISOMAX and the EVAL-ADBMS6830BMSW. +#. **Adjust and Monitor Voltages**: + * Adjust 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. + + + + +Battery Pack Monitoring +------------------------- + +Hardware Connection +~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: adbms2950_with_isomax_and_apard.png + + +1. **Attach EVAL-ISOMAX**: + * Connect the EVAL-ISOMAX to the AD-APARD32690-SL (or SDP-K1) through the Arduino Headers. + * Set **Jumpers P16, P17, and P18** on the EVAL-ISOMAX to **position 2 and 3** to use power from the main MCU. + +2. **Connect to EVAL-ADBMS2950-BASIC**: + * Use the provided isoSPI cable to connect EVAL-ISOMAX (P6) to EVAL-ADBMS2950-BASIC (isoA). + +3. **Powering EVAL-ADBMS2950-BASIC**: + * Option 1: Supply 5 V to J1 and set the current limit to 200 mA (consumes less than 50 mA in idle mode and ~100 mA in active mode). + * Option 2: Use a micro-USB cable connected to J10. + +4. **Attach MAX32625PICO**: + * Connect the MAX32625PICO to the AD-APARD32690-SL (or SDP-K1) using the 10-pin ribbon SWD cable, ensuring correct polarity. + +5. **Connect to PC**: + * Use a USB cable to connect the AD-APARD32690-SL (or SDP-K1) to the host PC. + + + + +Testing the Setup +~~~~~~~~~~~~~~~~~ + +#. **Open the BMS Browser GUI**. +#. **Select the COM Port**: + * In the **Interface Connection** section, choose the COM port associated with the AD-APARD32690-SL (or SDP-K1). +#. **Configure Daisy Chain**: + * Set the Generation drop-down box to **ADBMSGEN6**. + * From the Products list, select **ADBMS2950** and add it to the Daisy Chain. +#. **Launch the GUI**: + * Click **Launch**. + * The **Quick Measure** tab will open. Note: This utility supports only a single BMS product in a Daisy Chain. + * Click **Start Quick Measure** to begin measurements. +#. **Check Connections and Status**: + * Verify the Total PEC Status on the Memory Map. It should reflect true, + indicating a successful isoSPI link between the EVAL-ISOMAX and the + EVAL-ADBMS2950-BASIC. If it shows false, there is an error in the signal + chain. + + +Complete Daisy Chain +-------------------------- + +Once familiar with the setup for each of the individual boards the entire signal +chain can be verified. + +Hardware Connection +~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: daisychain_with_isomax_and_apard.png + +#. Connect the hardware using the DuraClik isoSPI cables. +#. Power each DC2472A 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 to the AD-APARD32690-SL (or SDP-K1 if this is used) + using the 10-pin ribbon SWD cable. Observe correct polarity when connecting + the SWD cable. +#. Connect a USB cable to the AD-APARD32690-SL (or SDP-K1 if this is used) and + the other end of the cable to the host PC. + + + +Testing the Setup +~~~~~~~~~~~~~~~~~~~~~~~ + +#. Launch the BMS Browser GUI following the previous instructions. +#. Choose the appropriate COM port associated to the AD-APARD32690-SL or SDP-K1 controller board. +#. 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. 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. + + .. image::daisy_chain_launch.png + +#. 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. + + .. image:: daisy_chain_sequences.png + +#. In the **Files** column, select **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. + + .. image:: daisy_chain_memory_map.png + +#. The **Plots** tab allows for the visualization of parameters recorded during the command loop. It supports the creation of up to four plots simultaneously. 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-ADBMS6830BMSW 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:: daisy_chain_plot1.png + + .. image:: daisy_chain_plot2.png + + .. image:: daisy_chain_plot3.png + +#. Plot settings can be saved to the PC to be reloaded for future session to save time. + + + + +Design and Integration Files +----------------------------------- + +.. admonition:: Download + +`EVAL-ISOMAX Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + + + + +Help and Support +------------------- + +For questions and more information about this product, connect with us through the Analog Devices :ez:`EngineerZone Support Community` . + diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_2950.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_2950.png new file mode 100644 index 00000000..2beefacf --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_2950.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:38f2eb60e6b8f0c5da3473455ee56243cde33908faf17aa0bed2cc9af040f33a +size 29480 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_6830.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_6830.png new file mode 100644 index 00000000..d78e5eb6 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_6830.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18b55dc1e88d302c22dda5e096bd79366ea088b4f403fd1f31a37c3b2e3d1434 +size 63473 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_daisy_chain.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_daisy_chain.png new file mode 100644 index 00000000..b6b87a33 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/isomax_daisy_chain.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0262b43f152b2db8d91c3c7bfa195d367f212a7523b9474a82356fca0e698faa +size 95560 diff --git a/docs/solutions/reference-designs/eval-isomax/hardware_guide/using_isomax_as_a_secondary_device_to_other_mcu.png b/docs/solutions/reference-designs/eval-isomax/hardware_guide/using_isomax_as_a_secondary_device_to_other_mcu.png new file mode 100644 index 00000000..984321bb --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/hardware_guide/using_isomax_as_a_secondary_device_to_other_mcu.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:18404169ad308e373c89dd38b649eb6016a55a02f4b4a5e00653627a7dfee23d +size 53207 diff --git a/docs/solutions/reference-designs/eval-isomax/index.rst b/docs/solutions/reference-designs/eval-isomax/index.rst new file mode 100644 index 00000000..5d5f05a9 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/index.rst @@ -0,0 +1,138 @@ +EVAL-ISOMAX +====================== + +Overview +------------ + +The :adi:`EVAL-ISOMAX` is an integrated dual isoSPI adapter and +microcontroller board featuring the :adi:`MAX32670` +high-reliability, ultra-low-power microcontroller and the +:adi:`ADBMS6822` dual isoSPI transceiver. This board allows +multiple ADBMS68xx battery monitors to be connected through daisy-chain +configuration. The EVAL-ISOMAX 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. + +.. image:: eval-isomax_angle.jpg + + +Features +-------------- + +* Low-cost integrated monitoring for BMS with on-board MCU and dual isoSPI chip +* Demonstrates SPI to isoSPI 2-wire datalinks +* Includes two isoSPi ports for reversible isoSPI support +* Configurable powering options for LPCM support isoSPI connections through + simple DuraClik connectors +* Stackable and allows daisy chain of up to eight (8) ADBMS6830BMSW boards +* With PC-based software for control and data analysis using Broad Market + Browser BMS GUI + + +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 2-Wheelers (E2Ws) such as E-scooter, E-bikes +* Light Electric Vehicles (LEV) + + + +What's Inside the Box? +------------------------------ + +.. image:: eval-isomax_package_contents.png + + +System Architecture +-------------------------- + +.. image:: eval-isomax_block_diagram.png + + + +Components and Connections +------------------------------- + +.. figure:: primary_side.png + :caption: EVAL-ISOMAX Hardware Components + + + +Use Cases +-------------- + +The EVAL-ISOMAX has an on-board ultralow-power Arm-Cortex M4-based MCU that is +suitable for broad market applications such as for IoT and industrial battery +management systems. The EVAL-ISOMAX board is recommended to be used with other +ADI broad market BMS boards such as the :adi:`EVAL-ADBMS6830BMSW` battery stack monitor and the :adi:`EVAL-ADBMS2950-BASIC` pack monitor. + +Users may also opt to use other microcontrollers for other applications +requiring more stringent timing, higher memory, or faster computing speed. Other +possible microcontrollers to be paired are the :adi:`SDP-K1` and :adi:`AD-APARD32690-SL` . + + +Option 1: Using the EVAL-ISOMAX as Standalone MCU with other ADI Broad Market BMS Boards +---------------------------------------------------------------------------------------------------- + +Sample Battery Monitoring Setup with the EVAL-ADBMS6830BMSW + + .. image:: using_isomax_with_other_adi_bm_boards.png + + + +Option 2: Using the EVAL-ISOMAX as a Secondary Device to other MCU Boards +--------------------------------------------------------------------------------- + +See below configuration using different MCUs: + +Sample Cell Monitoring Setup using the AD-APARD32690-SL as Main Microcontroller Board and EVAL-ISOMAX as isoSPI Adapter + + .. image:: eval-isomax_with_ad-apard32690-sl.png + + +Sample Pack Monitoring Setup using the SDP-K1 as Main Microcontroller Board and EVAL-ISOMAX as isoSPI Adapter + + .. image:: adbms2950_with_isomax_and_sdp-k1.png + + + + +Design and Integration Files +----------------------------------- + +.. admonition:: Download + + `EVAL-ISOMAX Design Support Package `_ + + * Schematic + * PCB Layout + * Bill of Materials + * Allegro Project + + + + +Help and Support +------------------- + +For questions and more information about this product, connect with us through the Analog Devices :ez:`EngineerZone Support Community` . + + + + +Up Next: Hardware & Software User Guide +---------------------------------------- + +.. toctree:: + :titlesonly: + :glob: + + */index diff --git a/docs/solutions/reference-designs/eval-isomax/primary_side.png b/docs/solutions/reference-designs/eval-isomax/primary_side.png new file mode 100644 index 00000000..2760f40a --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/primary_side.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6b0fc3d6b03d6a215e95f18713128d2dab9a932f567aae24d636da5dff9d912 +size 459854 diff --git a/docs/solutions/reference-designs/eval-isomax/software_guide/daisy_chain_connection.png b/docs/solutions/reference-designs/eval-isomax/software_guide/daisy_chain_connection.png new file mode 100644 index 00000000..e6d679aa --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/software_guide/daisy_chain_connection.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a8a4960c2eeda6f6e9d8dd1f57e15cbdd2be8fd568c1091720cf62c08b441c4 +size 37849 diff --git a/docs/solutions/reference-designs/eval-isomax/software_guide/data_recall.png b/docs/solutions/reference-designs/eval-isomax/software_guide/data_recall.png new file mode 100644 index 00000000..556d7271 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/diagnostics.png b/docs/solutions/reference-designs/eval-isomax/software_guide/diagnostics.png new file mode 100644 index 00000000..9e6aa3b8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/downloading_drivers.png b/docs/solutions/reference-designs/eval-isomax/software_guide/downloading_drivers.png new file mode 100644 index 00000000..f85d89bb --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/examples_folder.png b/docs/solutions/reference-designs/eval-isomax/software_guide/examples_folder.png new file mode 100644 index 00000000..99ae94ca --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/examples_installation_guide.png b/docs/solutions/reference-designs/eval-isomax/software_guide/examples_installation_guide.png new file mode 100644 index 00000000..f3b9615c --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/index.rst b/docs/solutions/reference-designs/eval-isomax/software_guide/index.rst new file mode 100644 index 00000000..03e162f8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/software_guide/index.rst @@ -0,0 +1,481 @@ +.. _eval-isomax software_guide: + + +Software User Guide +====================== + +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 EVAL-ISOMAX 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, 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. + * Then, 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. Default installation path will be on ``C:\Analog\`` + + +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\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. + + + +9. Open the Makefile inside ``C:\Analog\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\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/eval-isomax/software_guide/install_gui.png b/docs/solutions/reference-designs/eval-isomax/software_guide/install_gui.png new file mode 100644 index 00000000..bf94f261 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/installing_the_no-os_bms_drivers.png b/docs/solutions/reference-designs/eval-isomax/software_guide/installing_the_no-os_bms_drivers.png new file mode 100644 index 00000000..b4fed13f --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/interface_connection.png b/docs/solutions/reference-designs/eval-isomax/software_guide/interface_connection.png new file mode 100644 index 00000000..ca8b5dad --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/memory_map.png b/docs/solutions/reference-designs/eval-isomax/software_guide/memory_map.png new file mode 100644 index 00000000..8a06b817 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/plots.png b/docs/solutions/reference-designs/eval-isomax/software_guide/plots.png new file mode 100644 index 00000000..36474736 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/quick_measure.png b/docs/solutions/reference-designs/eval-isomax/software_guide/quick_measure.png new file mode 100644 index 00000000..7f0988a0 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/scheduler.png b/docs/solutions/reference-designs/eval-isomax/software_guide/scheduler.png new file mode 100644 index 00000000..c0edf483 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/software_guide/sequences.png b/docs/solutions/reference-designs/eval-isomax/software_guide/sequences.png new file mode 100644 index 00000000..a33a506f --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/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/eval-isomax/using_isomax_with_other_adi_bm_boards.png b/docs/solutions/reference-designs/eval-isomax/using_isomax_with_other_adi_bm_boards.png new file mode 100644 index 00000000..470c4137 --- /dev/null +++ b/docs/solutions/reference-designs/eval-isomax/using_isomax_with_other_adi_bm_boards.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:683faa45ff51309cad114f7b24677ece2bd321c169baea2cf3aaf8ada33409a4 +size 108817 diff --git a/docs/solutions/reference-designs/index.rst b/docs/solutions/reference-designs/index.rst new file mode 100644 index 00000000..6f1ff41b --- /dev/null +++ b/docs/solutions/reference-designs/index.rst @@ -0,0 +1,13 @@ +:orphan: + +Reference Designs +================== + +ADI provides and maintains a series of open-source software: + +.. toctree:: + :titlesonly: + :maxdepth: 1 + :glob: + + */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