diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583-designsupport.zip b/docs/solutions/reference-designs/eval-cn0583-som/cn0583-designsupport.zip new file mode 100644 index 000000000..a3a1be4fc --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583-designsupport.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4864bbe493d83795899c4ede4de50ed26f3a42e2c59374d5e3d1f33762341fee +size 7693684 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_en14604.zip b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_en14604.zip new file mode 100644 index 000000000..768e02bbd --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_en14604.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a63ca00f40320c39460e037e0dd4941dd9b0c10830807b73c7b6e2c2af7772c7 +size 104976 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_ul217.zip b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_ul217.zip new file mode 100644 index 000000000..0a4d6a628 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_cli_ul217.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5f0735473f183e7441879e8c676b96411fb6595a502910277f38e14e3f85022c +size 105024 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_cutout.jpg b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_cutout.jpg new file mode 100644 index 000000000..fe5a83914 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_cutout.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ca7a7d6360d74d350bab53d02fa7baa620ee6d8ab3c5e95b69260e667a62e3d8 +size 171924 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_front.jpg b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_front.jpg new file mode 100644 index 000000000..743e6c0e5 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_combo_front.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:443d908d58483df5aba441b2d65a29e2db48e47fd6e80fedd2d57a07f6ebb689 +size 725846 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/cn0583_no_alarm.zip b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_no_alarm.zip new file mode 100644 index 000000000..765962276 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/cn0583_no_alarm.zip @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6bd714a7c2618c998fac01fd5e61e0b63043c48efcc1b69da0f4b205cb4064ad +size 113324 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/daplink.png b/docs/solutions/reference-designs/eval-cn0583-som/daplink.png new file mode 100644 index 000000000..3504dd9fc --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/daplink.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:466ba3c5777bfd0c1708ceff972c97fdf0c6fd7bfc73cd3ef349dcf30d9ce54d +size 63845 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/device_manager.png b/docs/solutions/reference-designs/eval-cn0583-som/device_manager.png new file mode 100644 index 000000000..ce80b8080 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/device_manager.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:19c2868555efbe0950307b821793f5df3245ef82ba795e4991cc7ed181033995 +size 50627 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/en-14604_and_en54-7_test_report.pdf b/docs/solutions/reference-designs/eval-cn0583-som/en-14604_and_en54-7_test_report.pdf new file mode 100644 index 000000000..aea43f12d Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0583-som/en-14604_and_en54-7_test_report.pdf differ diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_jp1.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_jp1.jpg new file mode 100644 index 000000000..c4b6f1234 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_jp1.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bda7c48149581f06ba64145bdefe32c11a1cfcfc6af9ae6c6b4ed0386d5c3b3c +size 68063 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_sd_select.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_sd_select.jpg new file mode 100644 index 000000000..6664168e1 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_sd_select.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e02a7479319758f33b521f0543d869baccd558f915e5402c8e87a313958d1dfe +size 46673 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_swd_pinout.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_swd_pinout.jpg new file mode 100644 index 000000000..f4b638b37 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crr1_swd_pinout.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f87df9fa8f43b80c076270685b3857cba80a7c828b3a4e442d1d0721bd810864 +size 75929 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crrz_front.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crrz_front.jpg new file mode 100644 index 000000000..22d56f55c --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-crrz_front.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c46ced45876a068d043ac79d30289024987aeab348d4fd884a4517acca3b796 +size 1730055 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_front.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_front.jpg new file mode 100644 index 000000000..3dfa1aff8 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_front.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ccbd9ac2cdb755915f1900a78226d82dd3d9d2ef2326f46ecc757d12daf09673 +size 996157 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp1_jp4.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp1_jp4.jpg new file mode 100644 index 000000000..cc669e6a7 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp1_jp4.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a40b93111d84378ef3b558648fc09f07022b6c95f3effb268863889aa941a79d +size 89552 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp2_jp3.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp2_jp3.jpg new file mode 100644 index 000000000..c116dfa8e --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_jp2_jp3.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:97ed7679f39b0c259b0bea24890c44f5dd190e06fe10511923791ee0ca234f0d +size 114807 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_uart_header_circled.jpg b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_uart_header_circled.jpg new file mode 100644 index 000000000..fbb7f068d --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/eval-cn0583-som_uart_header_circled.jpg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:420fce83c3b2b26b55d585973293bdd24d2600684ec352d26aa7ba9aa044806a +size 123550 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/index.rst b/docs/solutions/reference-designs/eval-cn0583-som/index.rst new file mode 100644 index 000000000..dab3540ce --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/index.rst @@ -0,0 +1,708 @@ +.. _eval-cn0583-som: + +EVAL-CN0583-SOM +=============== + +Multistandard Micropower Verified Smoke Detection System-on-Module +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +Overview +-------- + +The hardware used for evaluation of the :adi:`CN0583` smoke detector +module is composed of two parts — the **EVAL-CN0583-SOM** smoke detector +system-on-module (SOM), and the **EVAL-CN0583-CRR1** carrier board. + +.. figure:: cn0583_combo_front.jpg + :width: 600 px + +The **EVAL-CN0583-SOM** is a standalone module designed for development of +smoke detection applications. The :adi:`CN0583` SOM integrates an +:adi:`ADPD188BI` smoke sensor, a :adi:`MAX32660` microcontroller, +and regulated DC power supplies needed for proper operation. + +The SOM only requires DC power and ground connections from a host system to +run a smoke detection application, and will output an alarm signal via a GPIO +pin. + +The **EVAL-CN0583-CRR1** is an easy-to-use carrier board developed for +evaluation of the SOM and enable rapid prototyping. The +:adi:`CN0583` carrier board has an onboard debugger based on the +:adi:`MAX32625PICO` that allows drag-and-drop programming of +the SOM and USB-UART communication. An indicator LED and buzzer are also +included on the board to allow users to implement a basic alarm function in +their smoke detector application. + +System-on-Module +---------------- + +Board Castellation +~~~~~~~~~~~~~~~~~~ + +The SOM has 28 castellated “pins” divided into two 14-pin rows and arranged in +a dual in-line pattern. These pins are used to supply power and interface +external circuitry with the SOM hardware, allowing access to the GPIO pins of +the :adi:`MAX32660` and :adi:`ADPD188BI`. The table below shows the default +pinout of the SOM when programmed with the :adi:`CN0583` demo application. + +.. figure:: eval-cn0583-som_front.jpg + :width: 400 px + +.. table:: SOM Pinout + + +------------+----------+-----------------------------------------------------+ + | Pin Number | Pin Name | Function | + +============+==========+=====================================================+ + | 1 | VBATT | Supply Voltage Input (2.2 V to 5.5 V) | + +------------+----------+-----------------------------------------------------+ + | 2 | \ | \ | + +------------+----------+-----------------------------------------------------+ + | 3 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 4 | \ | \ | + +------------+----------+-----------------------------------------------------+ + | 5 | NC | No connection. | + +------------+----------+-----------------------------------------------------+ + | 6 | GPIO0 | GPIO pin used for optional timing signals. | + | | | Connected to **GPIO0** of the ADPD188BI. | + +------------+----------+-----------------------------------------------------+ + | 7 | GPIO1 | GPIO pin used for optional timing signals. | + | | | Connected to **GPIO1** of the ADPD188BI. | + +------------+----------+-----------------------------------------------------+ + | 8 | LED_OUT | GPIO pin used to trigger an external visual | + | | | indicator (e.g., LED). Connected to **P0.4** of | + | | | the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 9 | BUTTON_IN| GPIO pin used for reading user inputs from an | + | | | external button. Connected to **P0.2** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 10 | ALARM_OUT| GPIO pin used to trigger an external audio device | + | | | (e.g., buzzer). Connected to **P0.5** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 11 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 12 | \ | \ | + +------------+----------+-----------------------------------------------------+ + | 13 | VBATT | 2.2V to 5.5V Supply. | + +------------+----------+-----------------------------------------------------+ + | 14 | \ | \ | + +------------+----------+-----------------------------------------------------+ + | 15 | SWDIO | Serial Wire Debug Data. Connected to **P0.0** of | + | | | the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 16 | SWDCLK | Serial Wire Debug Clock. Connected to **P0.1** of | + | | | the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 17 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 18 | RESET | Hardware Power Reset. Active-Low Input. | + +------------+----------+-----------------------------------------------------+ + | 19 | UART_TX | UART Tx Data. Connected to **P0.6** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 20 | UART_RX | UART Rx Data. Connected to **P0.7** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 21 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 22 | SCLK | SPI Clock. Connected to **P0.12** of the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 23 | CS | SPI Chip Select. Connected to **P0.13** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 24 | MISO | SPI Master Input, Slave Output. Connected to | + | | | **P0.10** of the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 25 | MOSI | SPI Master Output, Slave Input. Connected to | + | | | **P0.11** of the MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 26 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 27 | VBATT | 2.2V to 5.5V Supply. | + +------------+----------+-----------------------------------------------------+ + | 28 | \ | \ | + +------------+----------+-----------------------------------------------------+ + + +Refer to the :adi:`ADPD188BI` and :adi:`MAX32660` data sheets for details on +the available functions of their respective GPIO pins. + +.. tip:: + The actual functions of the digital pins are user-configurable and + are determined by how the :adi:`MAX32660` GPIO pins are configured in + the SOM firmware. When changing the pin assignments, check if the new pinout + will conflict with the onboard circuity of the the carrier board. + +.. important:: + Do not set **P0.0** and **P0.1** to any other function besides + **SWDIO** and **SWDCLK** to avoid issues with reprogramming the SOM using the + carrier board. + +If this was accidentally done and there is a need to upload a new firmware, +the flash memory of the :adi:`MAX32660` must first be erased prior +to reprogramming. To do this, install +`Maxim Microcontrollers SDK `__ +and `Visual Studio Code `__, +then perform the following steps: + +#. Create a new project from MaximSDK’s examples for :adi:`MAX32660` + in Visual Studio Code. +#. Build this project with the ‘**build**’ task in Visual Studio Code. +#. Connect the **RESET** pin of the SOM to any **GND** pin. +#. Run the ``erase flash`` task in Visual Studio Code. (You may see a ‘target + not halted’ message on the terminal, but this is expected). +#. Disconnect the **RESET** pin of the SOM from **GND**. +#. Power cycle the SOM by disconnecting the power source, and then immediately + reconnecting it afterward. + +UART Cable Connection +~~~~~~~~~~~~~~~~~~~~~ + +There are 4 test points on the SOM that can be used to access the UART port of +the :adi:`MAX32660` with an external cable. This can be used to +configure the smoke detector module during run time, or stream the measured +data back to a serial terminal program. + +.. figure:: eval-cn0583-som_uart_header_circled.jpg + :width: 400 px + +.. table:: UART Test Points + + +------------+----------+-----------------------------------------------------+ + | Pin Number | Pin Name | Function | + +============+==========+=====================================================+ + | 1 | 1V8 | Optional 1.8V Supply. | + | | | Alternative to **VBATT**. | + +------------+----------+-----------------------------------------------------+ + | 2 | GND | Ground. | + +------------+----------+-----------------------------------------------------+ + | 3 | UART_RX | UART Rx Data. Connected to **P0.7** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + | 4 | UART_TX | UART Tx Data. Connected to **P0.6** of the | + | | | MAX32660. | + +------------+----------+-----------------------------------------------------+ + +Input power to the SOM can be supplied either through the **VBATT** pins on +the board castellation, or via pin 1 of **JP1**. + +Refer to the table below on setting the **JP1** and **JP4** jumpers to select +the power source. + +.. figure:: eval-cn0583-som_jp1_jp4.jpg + :width: 400 px + ++----------------------+-----+------------------------------------------------+ +| Jumper Configuration | | Function | ++======================+=====+================================================+ +| JP1 | JP4 | \ | ++----------------------+-----+------------------------------------------------+ +| 1:2 | A/B | Input power is sourced from the carrier board | +| | | via the **VBATT** pins. *Default*. | ++----------------------+-----+------------------------------------------------+ +| 2:3 | B | Input power is sourced from a UART cable via | +| | | the **P1** test points. | ++----------------------+-----+------------------------------------------------+ + +LED Supply Voltage Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Depending on your specific power and application requirements, it may be +desirable to only supply power to one of the internal LEDs of the +:adi:`ADPD188BI`. Refer to the table below on setting the **JP2** +and **JP3** jumpers to enable the LED supply voltages. + +.. figure:: eval-cn0583-som_jp2_jp3.jpg + :width: 300 px + +.. table:: LED Supply Voltage Configuration + + +--------+---------------+----------------------------------------------------+ + | Jumper | Configuration | Function | + +========+===============+====================================================+ + | JP2 | A | 5V supply for the ADPD188BI blue LED is enabled. | + | | | *Default*. | + +--------+---------------+----------------------------------------------------+ + | JP2 | B | 5V supply for the ADPD188BI blue LED is disabled. | + +--------+---------------+----------------------------------------------------+ + | JP3 | A | 3.3V supply for the ADPD188BI infrared LED. | + | | | *Default*. | + +--------+---------------+----------------------------------------------------+ + | JP3 | B | 3.3V supply for the ADPD188BI infrared LED is | + | | | disabled. | + +--------+---------------+----------------------------------------------------+ + +Carrier Board +------------- + +The **EVAL-CN0583-CRR1** is a carier board designed to directly mount the +**EVAL-CN0583-SOM** and emulate a traditional smoke detector application. + +.. figure:: eval-cn0583-crrz_front.jpg + :width: 600 px + +SOM Mounting +~~~~~~~~~~~~ + +The two rows of pogo pins (P1, P2) are spring-loaded connectors used to mount +the SOM. The SOM is inserted between these connectors “one side at a time” by +aligning one castellated edge with a row of carrier board pogo pins, and then +pressing into them. Once one row of pins has been pushed in, the other side of +the SOM can be lowered and similarly inserted. Once released, the SOM will be +mechanically secured with each of the castellated pin electrically connected +with the pogo pins. + +.. figure:: cn0583_combo_cutout.jpg + :width: 400 px + +Power Source Options +~~~~~~~~~~~~~~~~~~~~ + +Depending on the application requirements, input power to the SOM can be +supplied in one of three ways. To select the power source, adjust the setting +of **JP1** as listed in the table below. + +.. figure:: eval-cn0583-crr1_jp1.jpg + :width: 400 px + +====== ============= ================================================== +Jumper Configuration Input Power +====== ============= ================================================== +JP1 BATTERY CR123A battery. +\ EXT SUPPLY External 2.2V to 5.5V power via the **P3** header. +\ USB POWER USB bus power via the **P6** connector. *Default* +====== ============= ================================================== + +.. important:: + Only the input power source of the SOM can be switched + using jumper **JP1**. The onboard programmer/debugger on the + carrier board will always draw power from the USB connector. + +Push Buttons +~~~~~~~~~~~~ + +There are two buttons on the :adi:`CN0583` carrier board. + +#. The **TEST** button can be used as a user input in the smoke detector + application loaded on the SOM (e.g. implementing a manual alarm test + function). Connected to **P0.2** of the :adi:`MAX32660` on the + SOM via pin 6 of **P1**. + +#. The **UPDATE** button is used when updating the firmware of the debugger. The + debugger is normally programmed with a DAPLINK image that provides USB Mass + Storage Device (MSD) drag-and-drop programming, USB Communications Device + Class (CDC) virtual serial port, and UART communication with the + :adi:`MAX32660` on the SOM. + +LED Indicators +~~~~~~~~~~~~~~ + +There are two LEDs on the :adi:`CN0583` carrier board. + +#. The **ALARM** LED can be used as a visual indicator in the smoke detection + application loaded on the SOM (e.g., showing when an alarm condition is + reached). This LED is connected to **P0.4** of the + :adi:`MAX32660` on the SOM via pin 7 of **P1**. + +#. **RGB** LED is used in the debugger interface of the carrier board, and will + blink when there is activity (e.g., sending commands to the SOM, updating the + debugger firmware). + +Buzzer +~~~~~~ + +The buzzer on the carrier board can be used as an audible alarm for the smoke +detector application loaded on the SOM. This is connected to **P0.5** of the +:adi:`MAX32660` on the SOM via pin 5 of **P1**. + +Data Storage +~~~~~~~~~~~~ + +The carrier board includes a micro-SD card slot to enable storage of smoke +data. To enable/disable this function, adjust the setting of jumper **JP2** as +listed in the table below. + +.. figure:: eval-cn0583-crr1_sd_select.jpg + :width: 400 px + +====== ============= ============================================== +Jumper Configuration Function +====== ============= ============================================== +JP2 ON Enable micro-SD card functionality. *Default* +\ OFF Disable micro-SD card functionality. +====== ============= ============================================== + +Programming the Debugger +~~~~~~~~~~~~~~~~~~~~~~~~ + +The debugger circuit used in the carrier board is based on the +:adi:`MAX32625PICO` application platform. By default, the +included :adi:`MAX32625` is already programmed with a bootloader +and DAPLINK application firmware so that it can be used immediately out of the +box. The included bootloader can be enabled by holding the **UPDATE** button +while powering on the board. If necessary however, the +:adi:`MAX32625` can be reprogrammed via the SWD signals available +on a keyed 10-pin connector (P7). + +.. figure:: eval-cn0583-crr1_swd_pinout.jpg + :width: 400 px + ++------------+----------+-----------------------------------------------------+ +| Pin Number | Pin Name | Function | ++============+==========+=====================================================+ +| 1 | VTREF | Logic-Level Reference Voltage for the SWD | +| | | interface. Connected to **VDDIO** (1.8V) of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ +| 2 | SWDIO | SWD Data I/O. Connected to **TMS/SWDIO** of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ +| 3 | GND | Ground. | ++------------+----------+-----------------------------------------------------+ +| 4 | SWCLK | SWD Clock. Connected to **TCK/SWDCLK** of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ +| 5 | GND | Ground. | ++------------+----------+-----------------------------------------------------+ +| 6 | DBG_TX | UART Tx. Connected to **P2.1** of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ +| 7 | NC | No connection. | ++------------+----------+-----------------------------------------------------+ +| 8 | DBG_RX | UART Rx. Connected to **P2.0** of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ +| 9 | NC | No connection. | ++------------+----------+-----------------------------------------------------+ +| 10 | RST | Software Reset. Connected to **SRSTN** of the | +| | | MAX32625. | ++------------+----------+-----------------------------------------------------+ + +CN0583 Example Demo +------------------- + +Demo Requirements +~~~~~~~~~~~~~~~~~ + +The following are required to implement the example :adi:`CN0583` demo +application: + + * :adi:`EVAL-CN0583-SOM ` + * :adi:`EVAL-CN0583-CRR1 ` + * ADPD188BI Smoke Chamber (Included with the SOM) + * Micro-SD Card (Optional) + * USB Micro-B Cable + * Computer (Must have a serial terminal installed) + +Hardware Setup +^^^^^^^^^^^^^^ + +#. Install the ADPD188BI smoke chamber on the primary side of the SOM. +#. Carefully insert the SOM between **P1** and **P2** of the carrier board, + following the cutout on the center. The proper orientation of the module will + have Pin 1 closest to the buzzer, and Pin 28 on the side with the test + button. +#. Connect the **P6** on the carrier board to the computer using the micro-USB + cable. +#. On the computer, check if the :adi:`CN0583` hardware setup is + recognized as a DAPLINK drive. This will indicate that the necessary drivers + are complete and correct. + +Programming the SOM +~~~~~~~~~~~~~~~~~~~ + +This step is only required if you want to update the firmware of the CN0583 SOM. +The programming may be done over DAPLINK, as following: + +#. Download the hex file for the demo application. Alternatively, you may use + your own hex file. + + .. admonition:: Download + + - **Algorithm for UL 217 8th Edition Standard:** + :download:`UL 217 hex with CLI stream ` + + - **Algorithm for EN14604:2005 Standard:** + :download:`EN14604 hex with CLI stream ` + + - **No Algorithm:** + :download:`no-alarm CLI hex ` + +#. Connect the EVAL-CN0583-CRR1 carrier board to your PC using an USB cable. +#. Wait for the DAPLINK directory to appear on your PC’s filesystem. +#. Copy the hex file to the DAPLINK directory. +#. The hex file will now be written in the MAX32660’s flash memory (this should + take a few seconds). After that, the DAPLINK directory will be deleted. +#. Wait for the DAPLINK directory to be created again (without unplugging the + USB cable). After that, the CN0583 SOM is programmed with the new firmware. + You may now use the CLI application by following the steps in the next + section. + +Serial Terminal Setup +~~~~~~~~~~~~~~~~~~~~~ + +A serial terminal is an application that runs on a PC or laptop that is +used to display data and interact with a connected device +(including many of the Circuits from the Lab reference designs). The +device’s UART peripheral is most often connected to a UART to USB interface +IC, which appears as a traditional COM port on the host PC/ laptop. +(Traditionally, the device’s UART port would have been connected to an RS-232 +line driver / receiver and connected to the PC via a 9-pin or 25-pin serial +port.) There are many open-source applications, and while there are many +choices, typically we use one of the following: + +- `Tera Term `__ +- `Putty `__ +- `Real Term `__ + +Before continuing, please make sure you download and install one of the above +programs. + +There are several parameters on all serial terminal programs that must be +setup properly in order for the PC and the connected device to communicate. +Below are the common settings that must match on both the PC side and the +connected UART device. + +#. **COM Port** - This is the physical connection made to your PC or laptop, + typically made through a USB cable but can be any serial communications + cable. You can determine the COM port assigned to your device by visiting the + device manager on your computer. Another method for identifying which COM + port is associated with a USB-based device is to look at which COM ports are + present before plugging in your device, then plug in your device, and look + for a new COM port. +#. **Baud Rate** - This is the speed at which data is being transferred from the + connected device to your PC. These parameters must be the same on both + devices or data will be corrupted. The default setting for most of the + reference designs in 115200. +#. **Data Bits** - The number of data bits per transfer. Typically, UART + transmits ASCII codes back to the serial port so by default this is almost + always set to 8-Bits. +#. **Stop Bits** - The number of **“stop”** conditions per transmission. For the + :adi:`CN0583` demo, this should be set to 2 for redundancy. +#. **Parity** - Is a way to check for errors during the UART transmission. + Unless otherwise specified, set parity to **“none”**. +#. **Flow Control** - Is a way to ensure that data lose between fast and slow + devices on the same UART bus are not lost during transmission. This is + typically not implemented in a simple system, and unless otherwise specified, + set to **“none”**. + +In many instances there are other options that each of the different serial +terminal applications provide, such as **local line echo** or **local line +editing**, and features like this can be turned on or off depending on your +preferences. This setup guide will not go over all the options of each tool, +but just the minor features that will make it easier to read back data from +the connected devices. + +**Example setup using PuTTY** + +#. Plug in your connected device using a USB cable or other serial cable. +#. Wait for the device driver of the connected device to install on your PC or + Laptop. +#. Open your device manager, and find out which COM port was assigned to your + device. + + .. figure:: device_manager.png + +#. Open up your serial terminal program (e.g., PuTTY). +#. Click on the serial configuration tab or window, and input the settings to + match the requirements of your connected device. The default baud rate for + most of the reference designs is 115200. Make sure that you use the correct + baud rate for your application. + + .. figure:: putty_settings.png + +#. Ensure you click on the checkboxes for **Implicit CR in every LF** and + **Implicit LF in every CF**. + +#. Ensure that local echo and line editing are enabled, so that you can see what + you type and are able to correct mistakes. (Some devices may echo typed + characters - if so, you will see each typed character twice. If this happens, + turn off local echo.) + + .. figure:: putty_terminal_options.png + +#. Click on the ``Open`` button, and as long as your connected device and serial + terminal program are setup the same, then you should be able to start + entering commands. + +Available Commands +~~~~~~~~~~~~~~~~~~ + +Typing **help** (or simply **h**) after the initial calibration sequence will +display the list of commands and their shortened versions. + +.. table:: Available Commands + + +--------------+--------------+--------------+--------------+--------------+ + | Function | Short | Verbose | Description | Example | + | | Command | Command | | | + +==============+==============+==============+==============+==============+ + | Application | **h** | **help** | Display the | | + | Control | | | help | | + | | | | tooltip. | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **s** | **stream** | Put the | To stream | + | | <*no*> | <*no*> | device in GO | data | + | | | | mode and | indefinitely:| + | | | | stream data | **s** | + | | | | from the | | + | | | | device to | To stream | + | | | | the | only 5 | + | | | | terminal. | samples: | + | | | | <*no*> = | **s 5** | + | | | | number of | | + | | | | samples to | | + | | | | stream. If | | + | | | | unspecified, | | + | | | | streams | | + | | | | indefinitely.| | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **i** | **idle** | Stop the | | + | | | | stream and | | + | | | | put the | | + | | | | device in | | + | | | | program | | + | | | | mode. | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **ms** | **mode_set** | Set the | To set the | + | | <*opt*> | <*opt*> | output mode | output mode | + | | | | of the data. | to PTR: | + | | | | <*opt*> = | **ms ptr** | + | | | | 'code' or | | + | | | | 'ptr'. | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **os** | **odr_set** | Set the | To set the | + | | <*odr*> | <*odr*> | output data | output data | + | | | | rate. | rate to 2.45 | + | | | | <*odr*> = | samples per | + | | | | new data | second: | + | | | | rate. | **os 2.45** | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **og** | **odr_get** | Display the | | + | | | | current | | + | | | | output data | | + | | | | rate. | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **n** | **note** | Print user | To print | + | | <*string*> | <*string*> | note on the | 'Note 1' on | + | | | | console. | the console: | + | | | | <*string*> = | **n Note 1** | + | | | | text to be | | + | | | | printed. | | + +--------------+--------------+--------------+--------------+--------------+ + | SD Card | **fo** | **file_open**| Open a text | To open | + | Control | <*name*> | <*name*> | file (\*.txt)| 'file1.txt' | + | | | | on the | on the | + | | | | micro-SD | micro-SD | + | | | | card to | card: | + | | | | store data. | **fo file1** | + | | | | If the file | | + | | | | does not | | + | | | | exist, it | | + | | | | will be | | + | | | | created. | | + | | | | <*name*> = | | + | | | | filename. | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **fc** | file_close | Save changes | | + | | | | to the | | + | | | | currently | | + | | | | open text | | + | | | | file and | | + | | | | close it. | | + +--------------+--------------+--------------+--------------+--------------+ + | ADPD188BI | **rr** | **reg_read** | Read a | To read | + | Control | <*addr*> | <*addr*> | specified | register | + | | | | ADPD188BI | 0x0A: | + | | | | register and | **rr a** | + | | | | display its | | + | | | | value. | | + | | | | <*addr*> = | | + | | | | register | | + | | | | address (hex)| | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **rw** | **reg_write**| Write a | To write | + | | <*addr*> | <*addr*> | specified | '0x12C' to | + | | <*val*> | <*val*> | value to a | register | + | | | | ADPD188BI | '0x0A': | + | | | | register. | **rw a 12c** | + | | | | <*addr*> = | | + | | | | register | | + | | | | address (hex)| | + | | | | <*val*> = | | + | | | | value (hex). | | + +--------------+--------------+--------------+--------------+--------------+ + | \ | **rd** | **reg_dump** | Reads and | | + | | | | displays all | | + | | | | ADPD188BI | | + | | | | register | | + | | | | values. | | + +--------------+--------------+--------------+--------------+--------------+ + +.. tip:: + By default, the output mode and data rate are set + to PTR and 0.163 (1/6) samples per second, respectively. + +Example Output Data +~~~~~~~~~~~~~~~~~~~ + +Below are examples of the :adi:`CN0583` boards outputting data in +PTR and raw codes and then exiting after several samples: + +.. figure:: terminal_ptr_stream.png + +.. figure:: terminal_code_stream.png + +Test Results +------------ + +Using the CN0583 hardware and the **ADSW-SMOKEALGO-PRODLIC algorithm**, the +setup was tested at a certified testing facility (Intertek) and passed all the +smoke sensor aspects of the UL-217 8th Edition Standards. You can view the +entire report below: + +- :download:`Test Report for UL-217 8th Edition using the ADSW-SMOKEALGO-PRODLIC algorithm with the CN0583 Hardware ` + +The hardware and algorithm were also verified using the EN54-7/EN14604 +Standard and the results are available here: + +- :download:`Test Report for EN54-7/EN-14604 Standard using the ADSW-SMOKEALGO-PRODLIC algorithm with the CN0583 Hardware ` + +Device Driver Support +--------------------- + +There are no-OS drivers provided for controlling the digital devices on the +:adi:`CN0583` boards. + +- `ADPD188BI No-OS Driver `__ +- :git-no-OS:`MAX31875 No-OS Driver ` + +Schematic, PCB Layout, Bill of Materials +---------------------------------------- + +.. admonition:: Download + + `CN0583 Design Support Package `__ + + - Schematics + - PCB Layout + - Bill of Materials + - Allegro Project + - Assembly Drawing + +Additional Information and Useful Links +--------------------------------------- + +- `CN0583 Design Support Package `__ +- :adi:`ADPD188BI Product Page ` +- :adi:`MAX31875 Product Page ` +- :adi:`MAX32660 Product Page ` +- :adi:`MAX77837 Product Page ` +- :adi:`ADP162 Product Page ` + +Help and Support +---------------- + +For questions and more information, please visit the :ez:`/`. diff --git a/docs/solutions/reference-designs/eval-cn0583-som/putty_settings.png b/docs/solutions/reference-designs/eval-cn0583-som/putty_settings.png new file mode 100644 index 000000000..37b9df521 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/putty_settings.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8fbacfbc22e46c2d8f490c8eb0322bc833f4a5e572a1dfb14f92d65ccc36a3a2 +size 16852 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/putty_terminal_options.png b/docs/solutions/reference-designs/eval-cn0583-som/putty_terminal_options.png new file mode 100644 index 000000000..82fd2b67f --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/putty_terminal_options.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17e1c40f9951c06bef740d5e918377b859b18f36f4081fd86c1d550acf9b8a76 +size 74121 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/terminal_code_stream.png b/docs/solutions/reference-designs/eval-cn0583-som/terminal_code_stream.png new file mode 100644 index 000000000..9e734d37b --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/terminal_code_stream.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a6b796c923d749ee6c40479b457a714335e994d9d0ea1cfc7cf6604e6b097919 +size 19615 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/terminal_ptr_stream.png b/docs/solutions/reference-designs/eval-cn0583-som/terminal_ptr_stream.png new file mode 100644 index 000000000..56e7cd9c6 --- /dev/null +++ b/docs/solutions/reference-designs/eval-cn0583-som/terminal_ptr_stream.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fc2b3f49eafeb696ffd57a6a09368b45c4c0ac2c2b4ebd97ae15cd4d4ae7ce38 +size 84657 diff --git a/docs/solutions/reference-designs/eval-cn0583-som/ul-217_8th_edition_test_report.pdf b/docs/solutions/reference-designs/eval-cn0583-som/ul-217_8th_edition_test_report.pdf new file mode 100644 index 000000000..144b37297 Binary files /dev/null and b/docs/solutions/reference-designs/eval-cn0583-som/ul-217_8th_edition_test_report.pdf differ