Git Product home page Git Product logo

esp_skeleton's Introduction

ESP Skeleton

Scope

This skeletion (template) aims to be a framework for ESP8266 Arduino projects.

Range of functions

  • Wifi connection
  • NTP time synchronization
  • MQTT connection
  • Internal LED flashs when MQTT messages are send/received
  • all configs are in the platform.io file
  • uses pass as password storage and other configurations
  • can create FHEM device configuration (MQTT device)
  • makefile integration
  • Over the air update & monitoring (OTA)

Arduino Example Code

The sample code included is used to switch an LED on and off via FHEM using MQTT.

Requirements

Pass

This project use pass for storing user credentials. Take a look in bin/create_build_flags.py for further details.

The ESP_OTA_PASSWORD var is exported via bin/set_my_vars.sh

Please make sure that pass is installed & configured.

Platform IO

Please install platformio with you os packet manager.

How to build this project?

make

How to upload this project via serial connection?

make serial

How to upload via OTA?

make ota

How to debug the environment vars?

make dump

How to clean up the cache?

make clean

How to edit code via vim?

make edit

How to clean build environment?

make clean

How can I create a FHEM device configuration?

make fhem

Note: The device config will be copied into the system clipboard automatically.

How can I monitor the device?

make monitor

esp_skeleton's People

Contributors

stormmurdoc avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.