Rohan Gurav / Mbed OS Sean_AdiSense1000_V21

ADISense1000 Version 2.1 code base

Fork of AdiSense1000_V21 by Sean Wilson

doc/README.md@19:a6d4bdcffb84, 2018-01-08 (annotated)

Committer:
kevin1990
Date:
Mon Jan 08 16:32:34 2018 +0000
Revision:
19:a6d4bdcffb84
v1.0_RC4 Release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevin1990 19:a6d4bdcffb84 1 ADI Sense Host Library {#mainpage}
kevin1990 19:a6d4bdcffb84 2 ======================
kevin1990 19:a6d4bdcffb84 3
kevin1990 19:a6d4bdcffb84 4 Introduction
kevin1990 19:a6d4bdcffb84 5 ------------
kevin1990 19:a6d4bdcffb84 6 ADI Sense is a new product line created by Analog Device Inc. (ADI) which aims
kevin1990 19:a6d4bdcffb84 7 to make it quicker and easier for its customers to develop hardware and firmware
kevin1990 19:a6d4bdcffb84 8 solutions based on ADI’s Precision Measurement technology, by combining smart
kevin1990 19:a6d4bdcffb84 9 online design tools and software-defined measurement processors which simplify
kevin1990 19:a6d4bdcffb84 10 the development of sophisticated high-precision measurement solutions.
kevin1990 19:a6d4bdcffb84 11
kevin1990 19:a6d4bdcffb84 12 The goal of the ADI Sense Host Library is to provide a high-level C/C++
kevin1990 19:a6d4bdcffb84 13 Application Programming Interface to demonstrate correct usage of the ADI Sense
kevin1990 19:a6d4bdcffb84 14 processors and simplify their integration with end-user application stacks.
kevin1990 19:a6d4bdcffb84 15
kevin1990 19:a6d4bdcffb84 16 ADI Sense 1000
kevin1990 19:a6d4bdcffb84 17 --------------
kevin1990 19:a6d4bdcffb84 18 The ADI Sense 1000 is a first-generation ADI Sense measurement processor which
kevin1990 19:a6d4bdcffb84 19 combines high-precision analog sensor inputs, SPI/I2C digital I/O interfaces
kevin1990 19:a6d4bdcffb84 20 and integrated DSP algorithms which transform the raw sensor input data into
kevin1990 19:a6d4bdcffb84 21 measurement values expressed in standard units ready for application use.
kevin1990 19:a6d4bdcffb84 22
kevin1990 19:a6d4bdcffb84 23 The ADI Sense 1000 processor is designed to run as a slave device, connected
kevin1990 19:a6d4bdcffb84 24 to and controlled by a separate host application processor.
kevin1990 19:a6d4bdcffb84 25
kevin1990 19:a6d4bdcffb84 26 The ADI Sense Host Application library currently includes support for the
kevin1990 19:a6d4bdcffb84 27 ADI Sense 1000 processor module, used in conjuction with the ST Nucleo F411RE
kevin1990 19:a6d4bdcffb84 28 host application processor running Mbed OS. Support for additional ADI Sense
kevin1990 19:a6d4bdcffb84 29 modules and host application processor platforms will be added in the future.
kevin1990 19:a6d4bdcffb84 30
kevin1990 19:a6d4bdcffb84 31 Resources
kevin1990 19:a6d4bdcffb84 32 ---------
kevin1990 19:a6d4bdcffb84 33 In the following sections, you will find more detailed information on the
kevin1990 19:a6d4bdcffb84 34 ADI Sense processors, ADI Sense Host Library API documentation, code examples,
kevin1990 19:a6d4bdcffb84 35 and more:
kevin1990 19:a6d4bdcffb84 36
kevin1990 19:a6d4bdcffb84 37 - [ADI Sense 1000 Overview](doc/adisense1000.md) provides details on the
kevin1990 19:a6d4bdcffb84 38 features of the ADI Sense 1000 processor module.
kevin1990 19:a6d4bdcffb84 39 - [API Reference](@ref ADI_Sense_Api) contains a detailed guide to the functions
kevin1990 19:a6d4bdcffb84 40 and datatypes provided on the ADI Sense Host Library API
kevin1990 19:a6d4bdcffb84 41 - [Examples](doc/examples.md) provides a guide to the various code examples
kevin1990 19:a6d4bdcffb84 42 provided as part of the ADI Sense Host Library
kevin1990 19:a6d4bdcffb84 43 - [Key Topics](doc/key_topics.md) offers more detailed information on a number of key
kevin1990 19:a6d4bdcffb84 44 topics such as processor configuration and dynamic characteristics
kevin1990 19:a6d4bdcffb84 45 - [Porting Guide](doc/porting.md) includes useful information for anyone who wishes
kevin1990 19:a6d4bdcffb84 46 to port the ADI Sense Host Library to a new host processor platform
kevin1990 19:a6d4bdcffb84 47