Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/notnavindu/adafruit-macropad-hotkeys-with-extensions

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/notnavindu/adafruit-macropad-hotkeys-with-extensions
Owner: notnavindu
License: gpl-3.0
Created: 2023-01-01T12:28:37.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-18T04:10:36.000Z (almost 2 years ago)
Last Synced: 2024-05-15T14:20:22.355Z (8 months ago)
Language: Python
Size: 1.09 MB
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-macropad - Macro Hotkeys + Extensions - hotkeys) script. Includes a Pomodoro timer, Bongo Cat and support to write your own extensions. By notnavindu (Applications)

README

        # Macropad Hotkeys With Extension Support

This is a modified version of the OG [Hotkeys](https://learn.adafruit.com/macropad-hotkeys) script from Adafruit. This script allows you to define custom functions to override the main loop to create your own functionalities. Currently, this repo includes a Pomodoro timer and a Bongo Cat thingy as extentions.

## Included Extensions

### Pomodoro Timer ([?](https://todoist.com/productivity-methods/pomodoro-technique))

![screenshot of pomodoro](screenshots/pomodoro.jpg)

`/macros/pomodoro.py`

#### Buttons

- **Green** - Start a pomodoro session

- **Yellow** - Pause/resume a session

- **Red** - Skip the current session

#### Configuring Pomodoro Sessions

You can customize the sessions duration, short break duration, long break duration and the sequence in which they occur by changing the constant variables defined in `/macros/pomodoro.py`

#### Notes

- "Slacking time" displayed after a session is calculated by `(time since first open) - (focused time)`

- Code is a bit messy as of now

### Bongo Cat

![bonogo](screenshots/bongo.jpg)

`/macros/bongo.py`

Bongo cat that taps when you tap. Based off of [this repo](https://github.com/christanaka/circuitpython-bongo). [Dependencies](https://github.com/christanaka/circuitpython-bongo#quick-start) required by bongo cat are included in the `/lib` directory.

## Creating your own extensions

You can use the template given in `/macros/sample.py` to create your own extensions.

## Roadmap

- [x] Base structure

- [x] Pomodoro Timer

- [x] Bongo Cat

- [x] Track focused time

- [x] Track slacking time

- [ ] Refactor/clean up Pomodoro timer 🧹