Analog Devices / Mbed OS ADISense1000_Example_FW

Example Code to get you up and running with ADISense1000

Fork of ADISense_ExampleFirmware by Sean Wilson

doc/adisense1000.md@0:76fed7dd9235, 2018-01-25 (annotated)

Committer:
seanwilson10
Date:
Thu Jan 25 16:00:23 2018 +0000
Revision:
0:76fed7dd9235
initial;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
seanwilson10 0:76fed7dd9235 1 ADI Sense 1000 Overview
seanwilson10 0:76fed7dd9235 2 =======================
seanwilson10 0:76fed7dd9235 3
seanwilson10 0:76fed7dd9235 4 [TOC]
seanwilson10 0:76fed7dd9235 5
seanwilson10 0:76fed7dd9235 6 ADI Sense 1000
seanwilson10 0:76fed7dd9235 7 --------------
seanwilson10 0:76fed7dd9235 8
seanwilson10 0:76fed7dd9235 9 # Overview {#overview}
seanwilson10 0:76fed7dd9235 10 The ADI Sense 1000 is a first-generation ADI Sense measurement processor which
seanwilson10 0:76fed7dd9235 11 combines high-precision analog sensor inputs, SPI/I2C digital I/O interfaces
seanwilson10 0:76fed7dd9235 12 and integrated DSP algorithms which transform the raw sensor input data into
seanwilson10 0:76fed7dd9235 13 measurement values expressed in standard units ready for application use.
seanwilson10 0:76fed7dd9235 14
seanwilson10 0:76fed7dd9235 15 The ADI Sense 1000 processor is designed to run as a slave device, connected
seanwilson10 0:76fed7dd9235 16 to and controlled by a separate host application processor.
seanwilson10 0:76fed7dd9235 17
seanwilson10 0:76fed7dd9235 18 The ADI Sense Host Application library currently includes support for the
seanwilson10 0:76fed7dd9235 19 ADI Sense 1000 processor module, used in conjuction with the ST Nucleo F411RE
seanwilson10 0:76fed7dd9235 20 host application processor running Mbed OS. Support for additional ADI Sense
seanwilson10 0:76fed7dd9235 21 modules and host application processor platforms will be added in the future.
seanwilson10 0:76fed7dd9235 22
seanwilson10 0:76fed7dd9235 23 # Interfaces {#interfaces}
seanwilson10 0:76fed7dd9235 24 ## Host Communication Interfaces {#interfaces_hostcommunication}
seanwilson10 0:76fed7dd9235 25 The interfaces in this section enable the connectivity with the host application
seanwilson10 0:76fed7dd9235 26 processor which is responsible for configuration and control of the ADI Sense
seanwilson10 0:76fed7dd9235 27 1000 device. Platform-specific host connection parameters may be specified via
seanwilson10 0:76fed7dd9235 28 the [ADI_SENSE_CONNECTION](@ref ADI_SENSE_CONNECTION) structure on the
seanwilson10 0:76fed7dd9235 29 [ADI Sense API](@ref ADI_Sense_Api) and low-level connectivity is accessed
seanwilson10 0:76fed7dd9235 30 via the [ADI Sense Host Portability Layer](@ref ADI_Sense_Host).
seanwilson10 0:76fed7dd9235 31
seanwilson10 0:76fed7dd9235 32 * SPI
seanwilson10 0:76fed7dd9235 33 + Standard 4-wire SPI interface (SCLK, MOSI, MISO, SS)
seanwilson10 0:76fed7dd9235 34 + Mode 0 (CPOL=0, CPHA=0)
seanwilson10 0:76fed7dd9235 35 + SCLK speeds up to 1.6MHz
seanwilson10 0:76fed7dd9235 36 * Signals
seanwilson10 0:76fed7dd9235 37 + ERROR
seanwilson10 0:76fed7dd9235 38 - active-high digital output
seanwilson10 0:76fed7dd9235 39 - signals an unrecoverable error condition to the host processor
seanwilson10 0:76fed7dd9235 40 + ALERT
seanwilson10 0:76fed7dd9235 41 - active-high digital output
seanwilson10 0:76fed7dd9235 42 - signals a warning/alert condition to the host processor
seanwilson10 0:76fed7dd9235 43 + DATAREADY
seanwilson10 0:76fed7dd9235 44 - active-high digital output
seanwilson10 0:76fed7dd9235 45 - signals a data ready condition to the host processor
seanwilson10 0:76fed7dd9235 46 + RESET
seanwilson10 0:76fed7dd9235 47 - active-low digital input
seanwilson10 0:76fed7dd9235 48 - pulse low for at least 4 microseconds to trigger a hardware reset of the module
seanwilson10 0:76fed7dd9235 49
seanwilson10 0:76fed7dd9235 50 ## Sensor Interfaces {#interfaces_sensor}
seanwilson10 0:76fed7dd9235 51 The following is an overview of the sensors interfaces available on the ADI Sense 1000
seanwilson10 0:76fed7dd9235 52 module. For latest information on the sensors currently supported by this library,
seanwilson10 0:76fed7dd9235 53 please refer to the [ADI Sense 1000 API](@ref ADI_Sense_1000_Api)
seanwilson10 0:76fed7dd9235 54
seanwilson10 0:76fed7dd9235 55 * Analog Sensor Interfaces
seanwilson10 0:76fed7dd9235 56 + CJC 1-2
seanwilson10 0:76fed7dd9235 57 - Intended for connecting 2-wire reference temperature sensors
seanwilson10 0:76fed7dd9235 58 - Analog sensor types currently supported:
seanwilson10 0:76fed7dd9235 59 - 2-wire PT100 RTD
seanwilson10 0:76fed7dd9235 60 - 2-wire PT1000 RTD
seanwilson10 0:76fed7dd9235 61 + SENSOR 0-3
seanwilson10 0:76fed7dd9235 62 - Intended for connecting a wide variety of precision analog sensors
seanwilson10 0:76fed7dd9235 63 - Analog sensor types currently supported:
seanwilson10 0:76fed7dd9235 64 - 2/3/4-wire PT100 RTD temperature sensors
seanwilson10 0:76fed7dd9235 65 - 2/3/4-wire PT1000 RTD temperature sensors
seanwilson10 0:76fed7dd9235 66 - Type-T/K/J Thermocouple temperature sensors
seanwilson10 0:76fed7dd9235 67 - 4/6-wire bridge tranducer temperature/pressure sensors
seanwilson10 0:76fed7dd9235 68 - 10k NTC Thermistor temperature sensors
seanwilson10 0:76fed7dd9235 69 + I\_MEAS
seanwilson10 0:76fed7dd9235 70 - Intended for connecting 4-20mA analog current sensors
seanwilson10 0:76fed7dd9235 71 + V\_MEAS
seanwilson10 0:76fed7dd9235 72 - Intended for connecting 0-10V analog voltage sensors
seanwilson10 0:76fed7dd9235 73 * Digital Sensor Interfaces
seanwilson10 0:76fed7dd9235 74 + SPI
seanwilson10 0:76fed7dd9235 75 - Intended for connecting support SPI digital sensors
seanwilson10 0:76fed7dd9235 76 - SPI digital sensor types currently supported:
seanwilson10 0:76fed7dd9235 77 - Honeywell TruStability HSC pressure sensors
seanwilson10 0:76fed7dd9235 78 - Analog Devices ADXL362 3-Axis MEMS accelerometer
seanwilson10 0:76fed7dd9235 79 + I2C
seanwilson10 0:76fed7dd9235 80 - Intended for connecting support SPI digital sensors
seanwilson10 0:76fed7dd9235 81 - SPI digital sensor types currently supported:
seanwilson10 0:76fed7dd9235 82 - Honeywell HumidIcon HIH9000 Series humidity sensors
seanwilson10 0:76fed7dd9235 83 - Sensirion SHT3x Series humidity sensors
seanwilson10 0:76fed7dd9235 84
seanwilson10 0:76fed7dd9235 85 ## Ancillary Interfaces {#interfaces_ancillary}
seanwilson10 0:76fed7dd9235 86 * External Reference Inputs
seanwilson10 0:76fed7dd9235 87 + REF 1-2
seanwilson10 0:76fed7dd9235 88 - Optional external reference inputs, for use with analog sensors
seanwilson10 0:76fed7dd9235 89 * Voltage Reference Outputs
seanwilson10 0:76fed7dd9235 90 + AVDD
seanwilson10 0:76fed7dd9235 91 - Analog voltage reference output (typically 3.3V)
seanwilson10 0:76fed7dd9235 92 + VDD
seanwilson10 0:76fed7dd9235 93 - Digital voltage reference output (typically 3.3V)
seanwilson10 0:76fed7dd9235 94