Wiki

Analog Devices Wiki

English
English
简体中文
简体中文
日本語
日本語
Руccкий
Руccкий
This version is outdated by a newer approved version.DiffThis version (07 Jul 2020 12:52) is a draft.
Approvals: 0/1

This is an old revision of the document!

Table of Contents

Smoke Detector Demo (w/ EVAL-CN0537-ADRZ)

The ADuCM3029_demo_cn0537 project provides a solution to implement a smoke detector with the capability to pass UL-217 specification, using the EVAL-CN0537-ARDZ and the EVAL-ADICUP3029. The Arduino shield uses a ADPD188BI to control the LEDs and photo-diodes, a temperature sensor for compensation, heater resistors to correct condensation and an SD card adapter to log operation data when not attended by a user terminal. The program can be controlled using a UART CLI.

General Description/Overview

The ADuCM_demo_cn0537 project uses EVAL-CN0537-ARDZ and EVAL-ADICUP3029 to provide an UL-217 compliant solution to smoke detection. The application gives user access to the ADPD188BI registers and other software defined application parameters to get smoke data at the desired rate and use it to calculate the Power Transfer Ratio (PTR) that directly correlates to the amount of smoke in the chamber. The alarm algorithm then takes the PTR measurement and measures it against a calculated baseline to determine if the alarm should trigger or not. The application has two main stages:

  1. Initialization;
  2. Main process.

In the initialization process the software modules and part drivers are instantiated and set to initial values. The application initializes the CLI process on top of the UART core and then sets up the ADPD188BI for smoke detection measurements. The program then reads calibration data from the part and uses them to set up the PTR measurements. After the PTR measurements are ready the application initializes the algorithm. This process may take a few seconds to complete. The application finishes initialization by setting up temperature compensation and real time clock counter. The main process is then started in idle mode.

The main process has two modes of operation: idle and streaming. In idle mode the serial CLI may be used to alter functionality parameters like ADPD188BI registers and output data rate. The CLI can also be used to set up SD card logging by creating a file on it.

Note that for the log to be complete, the file opened on the card must also be closed for the data to be saved.

Using the 'stream' command the process switches to streaming mode where smoke data is taken out at the set sampling rate. After temperature compensation and PTR calculation, data is fed to the algorithm to determine the alarm state. If the alarm is triggered the buzzer is activated and the alarm can only be reset by pressing the button on the shield or calling the 'reset_alarm' command on the CLI. If working parameters need to be adjusted it is recommended to return to idle mode by calling the 'idle' command and adjusting as necessary and then return to the stream mode. In streaming mode, if the serial terminal is connected, the application will display temperature compensated code values or PTR values at users choice, timestamped. The timestamp is in seconds relative to the start of the application. The alarm state is also displayed on the terminal while streaming.

Demo Requirements

The following is a list of items needed in order to replicate this demo.

  • Hardware
    • EVAL-ADICUP3029
    • EVAL-CN0537-ARDZ
    • Mirco USB to USB cable
    • PC or Laptop with a USB port
  • Software FIXME IS THIS NEEDED?
    • AduCM3029_demo_cn0414 demo application
    • CrossCore Embedded Studio (2.8.0 or higher)
    • ADuCM302x DFP (3.2.0 or higher)
    • ADICUP3029 BSP (1.1.0 or higher)
    • Serial Terminal Program
      • Such as Putty or Tera Term

Setting up the Hardware

  1. Set up the the EVAL-CN0537-ARDZ as shown in the Hardware User Guide.
  2. Connect EVAL-CN0537-ARDZ board to the EVAL-ADICUP3029.
  3. Connect a micro-USB cable to P10 connector of the EVAL-ADICUP3029 and connect it to a computer. The final setup should look similar to the picture below.

Configuring the Software

The ADuCM3029_demo_cn0503 does not need any software configuration. It can be built and run as is.

Outputting Data

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:

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.

  1. 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.
  2. 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.
  3. 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.
  4. Stop Bits - The number of “stop” conditions per transmission. This usually set to 1, but can be set to 2 for redundancy.
  5. Parity - Is a way to check for errors during the UART transmission. Unless otherwise specified, set parity to “none”.
  6. 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

  1. Plug in your connected device using a USB cable or other serial cable.
  2. Wait for the device driver of the connected device to install on your PC or Laptop.
  3. Open your device manager, and find out which COM port was assigned to your device.
  4. Open up your serial terminal program (Putty for this example)
  5. 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.
  6. Ensure you click on the checkboxes for Implicit CR in every LF and Implicit LF in every CF.
  7. 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.)
  8. Click on the open button, and as long as your connected device and serial terminal program are setup the same, than you should see data displaying.
Hint: If you see nothing in the serial terminal, try hitting the reset button on the embedded development board.

Available commands

Typing help or h after initial calibration sequence will display the list of commands and their short versions. Bellow is the short command list:

Function Command Description Example
Application commands
h Display available commands.
s Put the device in GO mode and stream data from the device to the terminal.
<no> = number of samples to be displayed. If not specified stream indefinitely. After the selected number of samples have been streamed the device will still sample, but not output data.
i Stop the stream.
<opt> = 1 to put the program in idle mode, 0 to keep the program in streaming mode, but stop streaming.
ms Set the output mode.
<opt> = 'CODE' to stream data in codes; 'PTR' to stream PTR data.
os Set output data rate. <odr> = new sample rate. os 2.45 = set sample rate to 2.45 samples per second.
og Get current output data rate.
ra Stop the alarm if triggered.
n Insert a note into the stream and also the SD card log if started. n Note 1 = print 'Note 1' on th terminal stream and SD card log if started.
ar Redo initialization of the algorithm. Useful if conditions changed significantly since start of the program.
hc Heater resistors control.
<opt> = 1 to turn heater resistors on; 0 to turn the heater resistors off.
t Do production test routine.
SD card commands
fo Open a file on the SD card. If the file does not exist it is created.
If the file exists and has information the new information will be appended.
<name> = name of the file to be opened. 		fo file1 = a file named 'file1.txt' is opened on the card.
fc Close the last file open on the SD card. This also saves the latest content to memory.
Device commands
rr Read device register.
<addr> = address of the register to be read in hexadecimal. 		rr a = read register 0xA
rw Write device register.
<addr> = address of the register to be read in hexadecimal.
<val> = value to be written to the register in hexadecimal. 		rw a 12c = write 0x12C to register 0xA
rd Read and display all device registers in one command.

Obtaining the Source Code

We recommend not opening the project directly, but rather import it into CrossCore Embedded Studios and make a local copy in your workspace.

The source code and include files of the ADuCM3029_demo_cn0414 can be found here:

AduCM3029_demo_cn0414 at Github

AduCM3029_demo_cn0414.HEX

How to use the Tools

The official tool we promote for use with the EVAL-ADICUP3029 is CrossCore Embedded Studio. For more information on downloading the tools and a quick start guide on how to use the tool basics, please check out the Tools Overview page.

Importing

For more detailed instructions on importing this application/demo example into the CrossCore Embedded Studios tools, please view our How to import existing projects into your workspace section.

Debugging

For more detailed instructions on importing this application/demo example into the CrossCore Embedded Studios tools, please view our How to configure the debug session section.

Project Structure

The program is composed of two main parts:

  1. Board setup with initial values.
  2. Main process.

Main flow chart

Board setup initializes UART, SPI and I2C communication and verifies if there is an active EVAL-CN0414-ARDZ board connected by reading the AD4111 ID register. Here is also initialized the update timer for the internal channel registers.

Board setup flow chart

The main process routine implements the CLI and calls the commands input by the user. This routine also checks the flags asserted in the asynchronous events (the update channel register flag, the HART received flag and the floating channel flags) and calls the appropriate handler methods. There is also a flag asserted by the channel register update rate and the ADC output data rate. If the update rate would be too close to the output data rate, the actual update rate might slow down to be possible for the program to maintain all functionality. The update rate may never be bigger or equal to the ADC output data rate divided by 8 (for 8 channels).

Process flow chart

The flow chart below represents the way the channel registers are updated. Only one channel is active at any one time (the channel that must be read).

Update channel flow chart

End of Document

resources/eval/user-guides/eval-adicup3029/reference_designs/demo_cn0537.1594119123.txt.gz · Last modified: 07 Jul 2020 12:52 by Andrei Drimbarean

Page Tools