|
|
Introduction
|
|
{+ This is the documentation of the latest developments in the OwnTech core software. +}
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
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.
|
|
# Introduction
|
|
|
|
|
|
|
|
Owntech Power API is based on the [Zephyr](https://zephyrproject.org/) real-time operating system which is extended using hardware-specific [modules](Zephyr-modules).
|
|
The OwnTech software suite is a collection of generic, user-friendly and easy to use software modules which can be used to control different types of switched mode power supplies, ranging from battery chargers to inverters.
|
|
|
|
|
|
|
|
|
Our software suite main characteristics are:
|
|
|
|
|
|
|
|
- Supports the STM32G474RE micro-controller
|
|
|
|
- Uses the [Zephyr](https://zephyrproject.org/) real-time operating system
|
|
|
|
- Deploys a high-level user API for fast prototyping
|
|
|
|
- Uses a mid-level abstraction layer called
|
|
|
|
- Uses low-level Zephyr-based modules for supporting advanced features of the micro-controller
|
|
|
|
|
|
|
|
#Licensing
|
|
|
|
|
|
|
|
The OwnTech software suite is licenced using a [LGPLV2.0](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html). This licence allows ease interfacing with both proprietary and open-source libraries, giving you freedom to choose the license of your future power library.
|
|
|
|
|
|
|
|
# Community Support
|
|
|
|
|
|
|
|
Community support is provided via Discord. [Please join us and ask away!](https://discord.gg/KAM8ukUYF5)
|
|
|
|
|
|
|
|
# Resources
|
|
|
|
|
|
|
|
Here's a quick summary of resources to help you find your way around:
|
|
|
|
|
|
|
|
[Getting started with the software](url)
|
|
|
|
[Understand the OwnTech Architecture](url)
|
|
|
|
[High Level API Guide](url)
|
|
|
|
[Mid level abstraction layer guide](url)
|
|
|
|
[Low level layer guide](url)
|
|
|
|
|
|
|
|
# Electricity basics
|
|
|
|
|
|
|
|
New to electricity? No problem! We are working on a suite of courses for introducing the topic and helping you getting up to speed on how to become an energy maker!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!---
|
|
|
|
# Distinguishing features
|
|
|
|
|
|
|
|
OwnTech software offers a large number of features dedicated to controlling power supplies, such as:
|
|
|
|
|
|
|
|
- Real-time control - You can create
|
|
|
|
|
|
|
|
Make a list here
|
|
|
|
|
|
|
|
## Working with OwnTech Power API
|
|
|
|
|
|
|
|
Working with OwnTech Power API
|
|
|
|
|
------------
|
|
|
|
|
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.
|
|
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.
|
|
|
|
|
|
|
|
Architecture of the API and the drivers
|
|
## Architecture of the API and the drivers
|
|
|
----
|
|
|
|
|
|
|
|
|
|
|
---> |
|
|
|
\ No newline at end of file |
