GithubHelp home page GithubHelp logo

togglrone's Introduction

togglrone

Implementing Toggl functionality with an ESP8266. Any naming similarities to a particular Swiss chocolate bar is purely intentional.

Hardware

This project makes use of the following hardware components:

  • ESP8266 (NodeMCU)
  • Rotary Encoder
  • ST7789 IPS Display

Code

This project is created using the Arduino IDE.

Libraries

The libraries listed below are required. There may be more which are referenced indirectly, but these are required as seperate installs:

  • ESP8226 Board Libraries
  • Adafruit ST7735 and ST7789 Library
  • Adafruit-GFX-Library
  • Button2
  • ESP Rotary
  • Toggl API (Note: Currently this project uses a custom implementation, available here. Work is being done to integrate these and some other changes into the primary API library.)

Structure

In order to get this code to work, you must create a "secrets.h" file, and in it include:

#ifndef SECRETS_H
#define SECRETS_H

#define TOKEN "<your-toggl-api-token>"
#define STASSID "<your-wifi-SSID>"
#define STAPSK  "<your-wifi-password>"
  
#endif

The other files are as follows:

  • togglrone.ino
    • Arduino project top level file.
  • pinDefinitions.h
    • Abstracts away pin definitions for easy reconfigurability.
  • hardware.h and hardware.cpp
    • Includes setup and configuration functionality for included hardware.

References

The following references proved useful in creating this project:

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.