PSoC Components Library

This is a PSoC Creator library project containing code to be used to interface a PSoC 5LP MCU to several hardware devices with PSoC Creator drag-and-drop components.

Included Components

This is a list of sensors contained in the library:

• ⚠️ ST LIS3DH
• ⚠️ InvenSense ICM-20948

This is a list of sensors that are being planned be included in the library in the near future:

• Sensirion SHT85
• Maxim Integrated DS2438
• Bosch BME280
• InvenSense MPU9250
• SSD1306 Display Driver

Setup

1. Clone the repository:

   git clone https://github.com/dado93/PSoC-Components-Library
   

2. Add the Library project as a dependency for your project in PSoC Creator. Go to Project > Dependencies > Add User Depencency

3. Use the provided components in your projects

Documentation

The documentation of the project relies on standard Doxygen-style comments in the PSoC Creator projects. Doxygen comments are then converted through breathe to be used by Sphinx using autodoc. The up-to-date documentation is then automatically uploaded to Read The Docs at this [link](https://psoc-components-library.readthedocs.io/en/latest/index.html). Due to the fact that PSoC Creator require API functions to use $INSTANCE_NAME in the source code, the conf.py file was modified to properly build the documentation of the library. The official documentation is built using ReadTheDocs.

1. Install Doxygen, breathe, and sphinx. If you are on Windows, make sure to add Doxygen.exe to your path, otherwise you will not be able to create the documentation.
2. Do not edit the Doxygen file, as it is already configured to properly create the required documentation.
3. cd docs
4. Run make html
5. You will find the documentation in the docs\_build folder