Rohan Gurav / Mbed OS Sean_AdiSense1000_V21

ADISense1000 Version 2.1 code base

Fork of AdiSense1000_V21 by Sean Wilson

doc/README.md@26:12d0204be712, 2018-03-26 (annotated)

Committer:
danodonovan
Date:
Mon Mar 26 14:50:05 2018 +0000
Revision:
26:12d0204be712
Child:
27:567abf893938
Adding files missed in previous commit for v1.0.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
danodonovan 26:12d0204be712 1 ADISENSE Host Library {#mainpage}
danodonovan 26:12d0204be712 2 =====================
danodonovan 26:12d0204be712 3
danodonovan 26:12d0204be712 4 Introduction
danodonovan 26:12d0204be712 5 ------------
danodonovan 26:12d0204be712 6 ADISENSE is a new product family from Analog Devices. The ADISENSE product
danodonovan 26:12d0204be712 7 family provide complete, flexible and versatile measurement solutions for a wide
danodonovan 26:12d0204be712 8 range of both compensated and uncompensated analog or digital sensors. The
danodonovan 26:12d0204be712 9 ADSNS1000 is the first product in this portfolio. The ADSNS1000 module
danodonovan 26:12d0204be712 10 seamlessly interfaces to temperature, pressure, humidity, acceleration and
danodonovan 26:12d0204be712 11 multiple other sensors. The module has all the building blocks to excite,
danodonovan 26:12d0204be712 12 measure and correct each sensor and generate an output in sensor related units
danodonovan 26:12d0204be712 13 such as @degreesC, @degreesF, psi, \%RH for example. In conjunction with the
danodonovan 26:12d0204be712 14 MeasureWare ecosystem, ADSNS1000 can be easily configured and optimised for the
danodonovan 26:12d0204be712 15 sensor types selected to meet the accuracy and measurement times required.
danodonovan 26:12d0204be712 16
danodonovan 26:12d0204be712 17 The goal of the ADISENSE Host Library is to provide a high-level C/C++
danodonovan 26:12d0204be712 18 Application Programming Interface to demonstrate correct usage of the ADSNS1000
danodonovan 26:12d0204be712 19 module and simplify their integration with end-user application stacks.
danodonovan 26:12d0204be712 20
danodonovan 26:12d0204be712 21 Resources
danodonovan 26:12d0204be712 22 ---------
danodonovan 26:12d0204be712 23 In the following sections, you will find more detailed information on the
danodonovan 26:12d0204be712 24 ADSNS1000, ADISENSE Host Library API documentation, code examples,
danodonovan 26:12d0204be712 25 and more:
danodonovan 26:12d0204be712 26
danodonovan 26:12d0204be712 27 - [ADSNS1000 Overview](doc/adsns1000.md) provides details on the
danodonovan 26:12d0204be712 28 features of the ADSNS1000 module
danodonovan 26:12d0204be712 29 - [API Reference](@ref ADISENSE_Api) contains a detailed guide to the functions
danodonovan 26:12d0204be712 30 and datatypes provided on the ADISENSE Host Library API
danodonovan 26:12d0204be712 31 - [Key Topics](doc/key_topics.md) offers more detailed information on a number of key
danodonovan 26:12d0204be712 32 topics such as processor configuration and dynamic characteristics
danodonovan 26:12d0204be712 33 - [Porting Guide](doc/porting.md) includes useful information for anyone who wishes
danodonovan 26:12d0204be712 34 to port the ADISENSE Host Library to a new host processor platform
danodonovan 26:12d0204be712 35