laroomy / laroomyapi_stm32

ST STM32 remote framework to interact with the LaRoomy App

LaRoomyApi_STM32

This is the LaRoomy Api remote framework library. Implementing this library enables your Portenta H7 project to interact with the LaRoomy App. The library is written for the ST STM32 platform and is intended to be used with the PlatformIO embedded development platform or the Arduino IDE.

The complete documentation for the library is provided on the LaRoomy Api Website.

How to use the Library

Usage with PlatformIO

Prerequisites

This library requires Platform IO to be installed in Visual Studio Code.

• Install Visual Studio Code
• Install Platform IO for VS Code

Implementation

• Add the dependency to the platformio.ini file of your project:

lib_deps = https://github.com/LaRoomy/LaRoomyApi_STM32

• Include the repective header in your main project file

#include <LaRoomyApi_STM32.h>

• Now you can use the LaRoomy Api with the respective access operator

LaRoomyApi.begin();

Usage with Arduino IDE:

Prerequisites

This library requires the Arduino IDE to be installed

• Download and install Arduino IDE

Implementation

• Download this repository as .zip file (click on '<>Code' and select 'Download ZIP')
• Open the Arduino IDE
• Click on the 'Sketch' entry on the menu and select 'Include Library' > 'Add .ZIP Library'
• Select the downloaded .zip file and press OK
• When the library was successful installed, it can be used by clicking on 'Sketch' > 'Include Library' in the menu and select the LaRoomy Api library in the section for the contributed libraries
• Now you can use the LaRoomy Api with the respective access operator:

LaRoomyApi.begin();

NOTE: This library depends on the ArduinoBLE library which must be also installed (if it isn't done automatically)

Examples

A detailed description of the examples with test schematics can be found here.

Further Information

Click here for detailed instructions on how to use the LaRoomyApi.