|
|
# Introduction
|
|
Introduction
|
|
|
|
---------
|
|
|
|
|
|
|
|
Owntech Power API is a modular embedded software designed to run on the OwnTech Spin board to provide power converter features.
|
|
The User level is made for you if you are willing to find all the basic features you can use to configure your SPIN and/or your TWIST.
|
|
|
The Core project is the main repository intended to be downloaded by end-users.
|
|
|
|
|
|
|
|
|
|
It provides all the configuration required to begin a project with OwnTech Power API, and includes the ability to automatically download additional [OwnTech-libraries](OwnTech-Power-API-Libraries).
|
|
|
|
|
|
|
|
|
|
Owntech Power API is based on the [Zephyr](https://zephyrproject.org/) real-time operating system which is extended using hardware-specific [modules](Zephyr-modules).
|
|
Owntech Power API is based on the [Zephyr](https://zephyrproject.org/) real-time operating system which is extended using hardware-specific [modules](Zephyr-modules).
|
|
|
|
|
|
|
|
Use the sidebar on the right of the page to navigate this Wiki.
|
|
|
|
|
|
|
|
|
|
# Working with OwnTech Power API
|
|
|
|
|
|
|
|
|
|
You need a working VS Code environment with the PlatformIO extension installed. Check [this page](Additional-resources) for additional information on how to install these.
|
|
|
|
|
|
|
|
|
|
Then, you need to clone the Core repository:
|
|
|
|
|
`git clone https://gitlab.laas.fr/owntech/power-api/core.git owntech_power_api`
|
|
|
|
|
|
|
|
|
|
⚠️ Due to Zephyr restriction, the path to the folder on the disk must not contain any space.
|
|
|
|
|
|
|
|
|
|
Then open the `owntech_power_api` folder using VS Code.
|
|
|
|
|
|
|
|
|
|
More details can be found in the [readme file](https://gitlab.laas.fr/owntech/power-api/core/-/blob/main/README.md).
|
|
|
|
|
|
|
|
|
|
# Contributing to OwnTech Power API
|
|
|
|
|
|
|
|
|
|
The policy of the project is to use merge requests for contribution.
|
|
Working with OwnTech Power API
|
|
|
You'll first need to fork the repository so that you can work on a private mirror. You can manage this mirror the way you want, however you must ensure that your changes are fast-forward regarding the `main` branch when you request a merge.
|
|
------------
|
|
|
|
You need a working VS Code environment with the PlatformIO extension installed. If you need help, begin by the tutorial [Setting up your environment](Twist-tutorial-Setting-up-your-environment) journey.
|
|
|
|
|
|
|
|
More details on this procedure can be found on [this page](Contributing-using-git). |
|
Architecture of the API and the drivers
|
|
\ No newline at end of file |
|
----
|
|
|
|
 |
