https://github.com/addono/teknimicro

Integrates microcontroller powered NeoPixel LED strips with the TeknIoT project. Mirrored from https://gitlab.com/TeknIoT/TekniMicro.
https://github.com/addono/teknimicro

esp8266 iot iot-light light micropython

Last synced: 3 months ago
JSON representation

Integrates microcontroller powered NeoPixel LED strips with the TeknIoT project. Mirrored from https://gitlab.com/TeknIoT/TekniMicro.

• Host: GitHub
• URL: https://github.com/addono/teknimicro
• Owner: Addono
• License: mit
• Created: 2020-09-09T19:34:36.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-20T15:48:03.000Z (almost 2 years ago)
• Last Synced: 2024-12-27T00:27:25.692Z (about 1 year ago)
• Topics: esp8266, iot, iot-light, light, micropython
• Language: Python
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


TekniMicro

  

    

  

  

    

  



---

## 📝 Table of Contents

- [About](#about)

- [Getting Started](#getting_started)

- [Deployment](#deployment)

- [Built Using](#built_using)

- [Authors](#authors)

## 🧐 About 

Integrates microcontroller* powered NeoPixel LED strips with the [TeknIoT](https://gitlab.com/tekniot/) project.

\* *Currently only ESP8266 is tested*

## 🏁 Getting Started 

### Prerequisites

This install guide assumes that you have Python installed locally and your micro controller is running [MicroPython](http://micropython.org/) with WebREPL enabled.

### Installing

First, install all required development dependencies:

```shell

pip install -r requirements.txt

```

## 🚀 Deployment 

First copy  `.env.template` to `.env` and set the hostname, password and port for WebREPL.

Now you're ready to deploy the codebase to your micro controller. The first time, it will ask for configuration details, like the WiFi SSID and MQTT hostname. These values will be persisted in `src/config.json`.

```shell

sh deploy.sh

```

## ⛏️ Built Using 

- [MicroPython](https://micropython.org/) - High Level Programming Language for Microcontrollers

- [MQTT](https://mqtt.org/) - Backend Communication Protocol

- [Gitlab](https://gitlab.com) - VCS

## ✍️ Authors 

- [Adriaan Knapen](https://aknapen.nl) [![Addono@Gitlab](https://img.shields.io/badge/Gitlab-@Addono-orange?style=for-the-badge&logo=gitlab)](https://gitlab.com/Addono) [![Addono@Github](https://img.shields.io/badge/Github-@Addono-black?style=for-the-badge&logo=github)](https://github.com/Addono)