Jim Carver / Mbed OS mbed-cloud-workshop-connect

Fork for workshops

simple-mbed-cloud-client/mbed-cloud-client/mbed-client-pal/DOXYGEN_FRONTPAGE.md@0:6b753f761943, 2018-10-12 (annotated)

Committer:
JimCarver
Date:
Fri Oct 12 21:22:49 2018 +0000
Revision:
0:6b753f761943
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JimCarver 0:6b753f761943 1 Mbed Platform Abstraction Layer (PAL)
JimCarver 0:6b753f761943 2 =================
JimCarver 0:6b753f761943 3
JimCarver 0:6b753f761943 4 The Mbed Platform Abstraction Layer (PAL) connects Mbed Cloud Client with the underlying platform.
JimCarver 0:6b753f761943 5
JimCarver 0:6b753f761943 6 The main purpose of PAL is to enable easy and fast Mbed Cloud Client services portability, allowing them to operate over wide range of ARM Cortex-based platforms running different operating systems with various libraries (networking, for example).
JimCarver 0:6b753f761943 7
JimCarver 0:6b753f761943 8 PAL has two layers:
JimCarver 0:6b753f761943 9
JimCarver 0:6b753f761943 10 - **Service API layer**: provides the PAL APIs for Mbed Cloud Client code. The APIs are identical for all platforms and operating systems, and you should not modify them.
JimCarver 0:6b753f761943 11 - **Platform API layer**: provides a standard set of baseline requirements for the platform. To allow Mbed Cloud Client to run on the target platform, you need to implement all requirements when you port. The implementation may be different for each target operating system or library; PAL provides reference implementations for several operating systems, including Mbed OS.
JimCarver 0:6b753f761943 12
JimCarver 0:6b753f761943 13 See the [Files](files.html) section to review documentation for specific APIs.
JimCarver 0:6b753f761943 14
JimCarver 0:6b753f761943 15 See the [full documentation and porting guide for PAL](/docs/v1.2/porting/index.html).
JimCarver 0:6b753f761943 16