Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nonik0/CardputerLoRaChat

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/nonik0/CardputerLoRaChat
Owner: nonik0
Created: 2024-01-10T06:01:46.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-05-07T19:01:06.000Z (7 months ago)
Last Synced: 2024-08-03T01:12:46.868Z (4 months ago)
Language: C++
Size: 165 KB
Stars: 51
Watchers: 7
Forks: 1
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-rainmana - nonik0/CardputerLoRaChat - (C++)

README

Simple chat app for M5 Cardputer and the M5 E220 LoRa modules. Doing for my own learning and enjoyment. Work in progress.

## Hardware used:
- [M5 Cardputer](https://shop.m5stack.com/products/m5stack-cardputer-kit-w-m5stamps3])
- [M5 E220 LoRa module](https://shop.m5stack.com/products/lora-unit-jp-version-with-antenna-e220) (optional if using ESP-NOW mode, see [Settings Tab Details](#settings-tab-details))

## Overview:
The interface is split into 5 tabs. The first three tabs are separate chat channels, the next tab shows the status of other users seen, and the last tab is for changing settings. Press the tab key to switch between tabs. The system bar shows the current username, the signal strength of the user seen with the best signal strength and incoming and outgoing messages, and the Cardputer's current battery level. LoRa modules are currently configured using the default settings from the [LoRa modules's library](https://github.com/m5stack/M5-LoRa-E220-JP). Modules must be configured initially to work, can do so in settings.

## Tab Info
Tab|Image|Info
---|---|---
Chat Tab|![chatWindow](https://github.com/nonik0/CardputerLoRaChat/assets/17152317/2f14c060-d6e2-4bbd-a743-855d09410a38)|A, B, and C chat channels. Use keyboard to type and enter to send messages.
Users Seen|![userTab](https://github.com/nonik0/CardputerLoRaChat/assets/17152317/cbe63ba1-48d6-478e-8def-97ffdfe75c00)|Shows users seen in chat and with pings. Shows last received signal strength and when last seen.
Settings|![settingsTab](https://github.com/nonik0/CardputerLoRaChat/assets/17152317/a966e694-fa3e-4055-949d-657cdcda9707)|Use arrow keys and enter to navigate settings. Use keyboard to update username when highlighted.

## Settings Tab Details

Setting|Info
---|---
Username|Min length 2, max length 8, ASCII only.
Brightness|Set display brightness [0-100]. If set very low, the display will automatically brighten when buttons are pressed.
Ping Mode|Send an occassional ping when not sending messages to show presence to other users.
Repeat Mode|Repeat back messages received. Just a testing function for now.
ESP-NOW Mode|Use the Wifi radio (using ESP-NOW protocol) to chat instead of LoRa! The range will be lower. :)
App Config|Writes current settings (username, brightness, ping mode, repeat mode) to SD card, will be reloaded on boot
LoRa Config|Writes register values to LoRa module. M0 and M1 switches must be set to off (config mode).

## TODO
See TODOs in code for now.

**ideas:**
- ACK Mode: know when users receive your message, resend/catch up?
- Mesh Mode: repeat messages from other users to extend range
- message scrolling
- saving chats to SD