Skip to content

dburnsii/MessageBox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


MessageBox

Client-Side application for sharing heartfelt messages
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Prototype

This project serves as the client application for the MessageBox project. MessageBox allows you to easily send messages to friends or loved ones with a simple and easy to use interface. The messages are sent to the MessageBox hardware, and the user on the other end is notified of the new message. After opening the box and reading the message, the box clears it's screen and listens for more messages. This provides a clean interface to send personal messages to someone at work or home, without distracting the recipient or requiring them to use any complex technology.

Built With

Getting Started

To get a MessageBox up and running follow these steps.

Prerequisites

Hardware

You'll need the following:

  • 3D Printed Parts in the CAD_Files/FreeCAD folder
  • PCB in the CAD_Files/KiCad folder
  • Off-the-shelf parts listed in BOM.md
  • Soldering Iron and Solder
  • (Optional) Heatshrink Tubing
  • (Optional) Hot Glue Gun

Software

You'll need the following:

  • PlatformIO

Installation

  1. To run the project, build and upload with PlatformIO:
pio run
pio run -t uploadfs
pio run -t upload

The uploadfs command will ensure all necessary SSL certificates are installed on the system, for use with HTTPS.

Usage

Setup instructions will appear on the TFT LCD attached to the box.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Desone Burns II - dburnsii@live.com

Project Link: https://github.com/dburnsii/MessageBox

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published