StatusPanel

eInk desk calendar and status board

Overview

Technical Details

• Devices

  • Firmware
    • NodeMCU
    • Python

• Clients

  • iOS

• Web Service

Development

StatusPanel follows the version numbering, build and signing conventions for InSeven Limited apps. Further details can be found here.

Dependencies

StatusPanel uses Git Submodules, so before doing anything else, you'll need to do:

git submodule update --init --recursive

N.B. You'll also need to run this command if the submodules change.

Use mise, to install the required build tools and dependencies:

mise install

Website

The website (https://statuspanel.io) is built using Jekyll and hosted on GitHub Pages. If you'd like to edit and serve locally, you run the following commands:

cd docs
bundle install
bundle exec jekyll serve

Contributing

We invite and welcome contributions! There's a pretty comprehensive list of issues to get you started, and our documentation is always in need of some care and attention.

Please recognise StatusPanel is a labour of love, and be respectful of others in your communications. We will not accept racism, sexism, or any form of discrimination in our community.

Licensing

StatusPanel is licensed under the MIT License (see LICENSE).