-
Notifications
You must be signed in to change notification settings - Fork 3
Source Tree Structure
The source folder structure is organized according to the described architecture in the Library Architecure section:
root
+-- docs/
+-- src/
+-- config/
+-- corelib/
+-- framework/
+-- fmwkA/
+-- pal/
+-- wrapper/
+-- ...
+-- fwmkB/
+-- pal/
+-- wrapper/
+-- ...
+-- ...
+-- pal/
+-- ...
+-- test
+-- ...
Additional folders for utilities and metadata files (i.e. makefiles, manifests, git files, LICENSE...) used by the software toolchain and development environment can (and will) as well be found in these folders together with the .hpp, .h, .cpp and .c sources.
Currently exceptions to this structure are found for backward compatibility reasons. Particularly, in order to keep the repository as an Arduino library, which requires to comply with the Arduino Library Specification 1.5.
Future revision will relocate these files more consistant with the proposed architecture, and consider separate release repositories for specific framework toolchain requirements.
2. Library Details
Library Architecture
Hall Switch API
Hall Speed API
PAL Interface
Source Tree Structure
Preprocessor Configuration
Porting Guide
Doxygen Docs
4. Software Frameworks
Arduino
- Getting Started
- Lib Installation
- Ino Examples
- Arduino API
- PlatformIO
Cypress WICED
- Getting Started
- Lib Installation
- WICED API
- Troubleshooting Guide
Raspberry Pi
- Getting Started
- Lib Installation
- Examples
- API usage