Jake Greaves / Mbed OS AdiSense1000_V21

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

doc/porting.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 Porting Guide
kevin1990 19:a6d4bdcffb84 2 =============
kevin1990 19:a6d4bdcffb84 3 [ADI Sense Host Portability Layer](@ref ADI_Sense_Host) describes a portability
kevin1990 19:a6d4bdcffb84 4 API layer which encapsulates the host platform-specific functions used by the
kevin1990 19:a6d4bdcffb84 5 ADI Sense Host Library to communicate with the ADI Sense module.
kevin1990 19:a6d4bdcffb84 6
kevin1990 19:a6d4bdcffb84 7 Porting the ADI Sense Host Library to a new hardware platform and/or operating
kevin1990 19:a6d4bdcffb84 8 system (OS) should involve replacing only the portability layer API functions
kevin1990 19:a6d4bdcffb84 9 with a suitable implementation for the target platform.
kevin1990 19:a6d4bdcffb84 10
kevin1990 19:a6d4bdcffb84 11 A fully-functional communication interface implementation (i.e. @ref
kevin1990 19:a6d4bdcffb84 12 ADI_Sense_Spi) is required, as is @ref ADI_Sense_Time which provides time-delay
kevin1990 19:a6d4bdcffb84 13 functions for the ADI Sense Host Library. However, other elements of the
kevin1990 19:a6d4bdcffb84 14 portability layer, such as @ref ADI_Sense_Gpio and @ref ADI_Sense_Log, may be
kevin1990 19:a6d4bdcffb84 15 substituted with dummy implementations if necessary (though some
kevin1990 19:a6d4bdcffb84 16 [examples](doc/examples.md) may not function correctly as a result).
kevin1990 19:a6d4bdcffb84 17
kevin1990 19:a6d4bdcffb84 18 Source code for the ST Nucleo / mbed portability layer implementation is located
kevin1990 19:a6d4bdcffb84 19 in the following sub-directory within the ADI Sense Host Library source package:
kevin1990 19:a6d4bdcffb84 20
kevin1990 19:a6d4bdcffb84 21 <path_to_library>/host/src/mbed/
kevin1990 19:a6d4bdcffb84 22