Sean Wilson / Mbed OS AdiSense1000_V21

AdiSense1000_V21 MBED API

Fork of AdiSense1000 by PoC_Team

doc/adsns1000.md@25:c5bff546082f, 2018-03-07 (annotated)

Committer:
danodonovan
Date:
Wed Mar 07 00:58:50 2018 +0000
Revision:
25:c5bff546082f
Child:
27:567abf893938
Child:
28:4eb837cd71df
Updating example to adisense1000 v1.0.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
danodonovan 25:c5bff546082f 1 ADSNS1000 Overview
danodonovan 25:c5bff546082f 2 =======================
danodonovan 25:c5bff546082f 3
danodonovan 25:c5bff546082f 4 [TOC]
danodonovan 25:c5bff546082f 5
danodonovan 25:c5bff546082f 6 ADSNS1000
danodonovan 25:c5bff546082f 7 --------------
danodonovan 25:c5bff546082f 8
danodonovan 25:c5bff546082f 9 # Overview {#overview}
danodonovan 25:c5bff546082f 10 ADISENSE product family provide complete, flexible and versatile measurement
danodonovan 25:c5bff546082f 11 solutions for a wide range of both compensated and uncompensated analog or
danodonovan 25:c5bff546082f 12 digital sensors. The ADSNS1000 is the first product in this portfolio. The
danodonovan 25:c5bff546082f 13 ADSNS1000 module seamlessly interfaces to temperature, pressure, humidity,
danodonovan 25:c5bff546082f 14 acceleration and multiple other sensors. The module has all the building blocks
danodonovan 25:c5bff546082f 15 to excite, measure and correct each sensor and generate an output in sensor
danodonovan 25:c5bff546082f 16 related units such as oC, oF, psi, %RH. In conjunction with the MeasureWare
danodonovan 25:c5bff546082f 17 ecosystem, ADSNS1000 can be easily configured and optimised for the sensor types
danodonovan 25:c5bff546082f 18 selected to meet the accuracy and measurement times required.
danodonovan 25:c5bff546082f 19
danodonovan 25:c5bff546082f 20 The ADSNS1000 provides up to 11 measurement channels. The module has 4
danodonovan 25:c5bff546082f 21 measurement inputs that connect to uncompensated analog sensors. It also
danodonovan 25:c5bff546082f 22 includes two dedicated analog measurement inputs for temperature compensation
danodonovan 25:c5bff546082f 23 such as cold junction compensation of the thermocouples. ADSNS1000 includes a
danodonovan 25:c5bff546082f 24 0-10V measurement input, 0-20mA measurement input, two I2C measurement inputs
danodonovan 25:c5bff546082f 25 and one SPI measurement input also which are useful for compensated sensors such
danodonovan 25:c5bff546082f 26 as pressure, humidity and accelerometers.
danodonovan 25:c5bff546082f 27
danodonovan 25:c5bff546082f 28 The ADSNS1000 communicates to the host application processor via a dedicated SPI
danodonovan 25:c5bff546082f 29 interface. The ADSNS1000 operates as a slave device when communicating with the
danodonovan 25:c5bff546082f 30 host application processor.
danodonovan 25:c5bff546082f 31
danodonovan 25:c5bff546082f 32 The ADSNS1000 host application library currently includes support for the
danodonovan 25:c5bff546082f 33 ADSNS1000 module when used in conjunction with the ST Nucleo F411RE host
danodonovan 25:c5bff546082f 34 application processor running in the Arm Mbed development environment.
danodonovan 25:c5bff546082f 35
danodonovan 25:c5bff546082f 36 # Interfaces {#interfaces}
danodonovan 25:c5bff546082f 37 ## Host Communication Interfaces {#interfaces_hostcommunication}
danodonovan 25:c5bff546082f 38 The interfaces in this section enable the connectivity with the host application
danodonovan 25:c5bff546082f 39 processor which is responsible for communication, configuration and control of
danodonovan 25:c5bff546082f 40 the ADSNS1000 module. Platform specific host connection parameters may be
danodonovan 25:c5bff546082f 41 specified via the [ADI_SENSE_CONNECTION](@ref ADI_SENSE_CONNECTION) structure on
danodonovan 25:c5bff546082f 42 the [ADISENSE API](@ref ADISENSE_Api) and low-level connectivity is accessed via
danodonovan 25:c5bff546082f 43 the [ADISENSE Host Portability Layer](@ref ADISENSE_Host).
danodonovan 25:c5bff546082f 44
danodonovan 25:c5bff546082f 45 * SPI
danodonovan 25:c5bff546082f 46 + Standard 4-wire SPI interface (SCLK, MOSI, MISO, SS)
danodonovan 25:c5bff546082f 47 + Mode 0 (CPOL=0, CPHA=0)
danodonovan 25:c5bff546082f 48 + SCLK speeds up to 1.6MHz
danodonovan 25:c5bff546082f 49 * Signals
danodonovan 25:c5bff546082f 50 + ERROR
danodonovan 25:c5bff546082f 51 - active-high digital output
danodonovan 25:c5bff546082f 52 - signals an error condition to the host processor
danodonovan 25:c5bff546082f 53 - an error condition signifies a fault that will affect the integrity of the
danodonovan 25:c5bff546082f 54 measurement
danodonovan 25:c5bff546082f 55 - operation of the ADSNS1000 will cease to continue until the ERROR is
danodonovan 25:c5bff546082f 56 rectified
danodonovan 25:c5bff546082f 57 + ALERT
danodonovan 25:c5bff546082f 58 - active-high digital output
danodonovan 25:c5bff546082f 59 - signals a warning/alert condition to the host processor
danodonovan 25:c5bff546082f 60 - measurement operation will continue on the ADSNS1000 in an ALERT condition
danodonovan 25:c5bff546082f 61 + DATAREADY
danodonovan 25:c5bff546082f 62 - active-high digital output
danodonovan 25:c5bff546082f 63 - going high to indicate the completion of a sensor measurement
danodonovan 25:c5bff546082f 64 - can be programmed to go high on the completion of each individual
danodonovan 25:c5bff546082f 65 measurement, it can go high when a cycle of measurements is complete or
danodonovan 25:c5bff546082f 66 when the FIFO is full
danodonovan 25:c5bff546082f 67 + RESET
danodonovan 25:c5bff546082f 68 - active-low digital input
danodonovan 25:c5bff546082f 69 - pulse low for at least 4 microseconds to trigger a hardware reset of the
danodonovan 25:c5bff546082f 70 module
danodonovan 25:c5bff546082f 71
danodonovan 25:c5bff546082f 72 ## Sensor Interfaces {#interfaces_sensor}
danodonovan 25:c5bff546082f 73 The following is an overview of the sensor interfaces available on the ADSNS1000
danodonovan 25:c5bff546082f 74 module. For latest information on the sensors currently supported by this
danodonovan 25:c5bff546082f 75 library, please refer to the [ADSNS1000 API](@ref ADSNS1000_Api)
danodonovan 25:c5bff546082f 76
danodonovan 25:c5bff546082f 77 * Analog Sensor Interfaces
danodonovan 25:c5bff546082f 78 + CJC 0-1
danodonovan 25:c5bff546082f 79 - Intended for connecting temperature measurement sensors for temperature
danodonovan 25:c5bff546082f 80 compensation
danodonovan 25:c5bff546082f 81 - Analog sensor types currently supported:
danodonovan 25:c5bff546082f 82 - 2-wire RTD PT100
danodonovan 25:c5bff546082f 83 - 2-wire RTD PT1000
danodonovan 25:c5bff546082f 84 + SENSOR 0-3
danodonovan 25:c5bff546082f 85 - Intended for connecting a wide variety of uncompensated analog sensors
danodonovan 25:c5bff546082f 86 - Analog sensor types currently supported:
danodonovan 25:c5bff546082f 87 - 2/3/4-wire PT100 RTD temperature sensors
danodonovan 25:c5bff546082f 88 - 2/3/4-wire PT1000 RTD temperature sensors
danodonovan 25:c5bff546082f 89 - Type-T/K/J Thermocouple temperature sensors
danodonovan 25:c5bff546082f 90 - 4/6-wire bridge transducers
danodonovan 25:c5bff546082f 91 - Thermistors 10k NTC temperature sensors
danodonovan 25:c5bff546082f 92 + I\_MEAS
danodonovan 25:c5bff546082f 93 - Intended for connecting compensated current output 0-20mA analog sensors
danodonovan 25:c5bff546082f 94 + V\_MEAS
danodonovan 25:c5bff546082f 95 - Intended for connecting compensated voltage output 0-10V analog sensors
danodonovan 25:c5bff546082f 96 * Digital Sensor Interfaces
danodonovan 25:c5bff546082f 97 + SPI
danodonovan 25:c5bff546082f 98 - Intended for connecting supported SPI digital sensors
danodonovan 25:c5bff546082f 99 - SPI digital sensor types currently supported:
danodonovan 25:c5bff546082f 100 - Honeywell TruStability pressure sensors
danodonovan 25:c5bff546082f 101 - Analog Devices ADXL362 3-Axis MEMS accelerometer
danodonovan 25:c5bff546082f 102 + I2C
danodonovan 25:c5bff546082f 103 - Intended for connecting support I2C digital sensors
danodonovan 25:c5bff546082f 104 - I2C digital sensor types currently supported:
danodonovan 25:c5bff546082f 105 - Honeywell HumidIcon HIH9000 Series humidity sensors
danodonovan 25:c5bff546082f 106 - Sensirion SHT3x Series humidity sensors
danodonovan 25:c5bff546082f 107
danodonovan 25:c5bff546082f 108 ## Ancillary Interfaces {#interfaces_ancillary}
danodonovan 25:c5bff546082f 109 * External Reference Inputs
danodonovan 25:c5bff546082f 110 + REF 1-2
danodonovan 25:c5bff546082f 111 - Optional external reference inputs, for use with analog sensors
danodonovan 25:c5bff546082f 112 * Supply Voltages / Voltage Reference Outputs
danodonovan 25:c5bff546082f 113 + AVDD
danodonovan 25:c5bff546082f 114 - Analog voltage output
danodonovan 25:c5bff546082f 115 - The filtered VDD power supply is available on AVDD
danodonovan 25:c5bff546082f 116 - This supply can be used as the power supply for voltage out, current out
danodonovan 25:c5bff546082f 117 or digital out compensated sensors.
danodonovan 25:c5bff546082f 118 + VDD
danodonovan 25:c5bff546082f 119 - Analog Supply Voltage
danodonovan 25:c5bff546082f 120 - The voltage on VDD is referenced to GND
danodonovan 25:c5bff546082f 121 - The differential between VDD and GND must be between 3 V and 3.6 V
danodonovan 25:c5bff546082f 122