https://github.com/golain-io/golain-esp-sdk

Golain Device SDK for esp-idf
https://github.com/golain-io/golain-esp-sdk

ble bluetooth esp-idf esp32 iot mqtt protobuf sensors

Last synced: 11 days ago
JSON representation

Golain Device SDK for esp-idf

• Host: GitHub
• URL: https://github.com/golain-io/golain-esp-sdk
• Owner: golain-io
• License: mit
• Created: 2023-02-09T14:10:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-07T20:48:07.000Z (over 1 year ago)
• Last Synced: 2024-12-09T14:41:36.362Z (2 months ago)
• Topics: ble, bluetooth, esp-idf, esp32, iot, mqtt, protobuf, sensors
• Language: C
• Homepage: https://docs.golain.io
• Size: 1.44 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Golain ESP SDK

This repo is a set of components created to make it conviniet to get started with an IoT Product with the Golain Platform.

### Works with

| Hardware        | ESP-IDF version | Status | Tested |

| ---             | ---      | ---     | ---                |

| ESP32-WROOM32-D | `v4.4.x` | `beta`  | :heavy_check_mark: |

| ESP32-WROOM32-D | `v5.x`   | `beta`  | :heavy_check_mark: |

| ESP32-C3        | `v4.4.x` | `beta`  | :heavy_check_mark: |

| ESP32-C3        | `v5.x`   | `beta`  | :heavy_check_mark: |

### Getting started

It is expected that this repository is added as a submodule inside your project under the component directory.

`Sample iot-shell coming soon!`

Assuming that your project is already a git repository, this can be done by:

1. run `git submodule init` inside your project

2. run `git submodule add https://github.com/golain-io/golain-esp-sdk components/`

3. navigate to the cloned repo by executing `cd components/golain-esp-sdk`

4. run `git submodule update --init --recursive` to pull all dependent components as well

5. Update your CMakeLists.txt to include the components directory

### Details

Usage guides for each individual component are included in the component READMEs, and implmentations can be found under the `example` folders under each component