morgan
/
OMOTE
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Klaus Musch 2024-03-10 15:54:55 +01:00 committed by GitHub
parent 47f644b64a
commit 761310cff2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -33,36 +33,41 @@ OMOTE is an ESP32 based open source universal remote. Its capacitive 2.8” touc
* [knolleary/PubSubClient](https://github.com/knolleary/PubSubClient)@^2.8 * [knolleary/PubSubClient](https://github.com/knolleary/PubSubClient)@^2.8
* [Chris--A/Keypad](https://github.com/Chris--A/Keypad) (modified for inverted logic) * [Chris--A/Keypad](https://github.com/Chris--A/Keypad) (modified for inverted logic)
### The State of This Project ### The state of this Project
#### Hardware
The hardware for OMOTE is designed to be easily replicated, using 3D-printed parts, a 2-layer PCB and commonly available components. The mechanical and PCB design can be considered mostly complete. Still, there might be areas for improvement, for example the IR range could be further optimized. The hardware for OMOTE is designed to be easily replicated, using 3D-printed parts, a 2-layer PCB and commonly available components. The mechanical and PCB design can be considered mostly complete. Still, there might be areas for improvement, for example the IR range could be further optimized.
There is still a lot of work left to be done in terms of software. Right now, network settings, buttons and screen layouts are hard-coded. Controlling devices via MQTT is more of a tech demo at the moment and the network connection might not be perfectly reliable. Making the interface configurable, e.g. using a web interface, is a long-term goal. #### Software
The software can be adjusted to your needs. You can add your amplifier, TV and media player. The software is an example made up of an amplifier and TV controlled with infrared, a Fire TV controlled with BLE and some smart home devices controlled with MQTT.
Please see the [wiki on how to understand and modify the software.](https://github.com/CoretechR/OMOTE/wiki/How-to-understand-and-modify-the-software)
You need to have PlatformIO running, and you need to be able to compile and flash your own firmware. There is no prebuild firmware.
As a long term goal, maybe a prebuild firmware will be published, where you can configure your OMOTE via a web interface.
### To Do ### To Do
Currently I have no idea if and when this will be done. But these would be the next steps: Short term goals
- [ ] simulator for creating pages in Windows, WSL2 and Linux
- [ ] scene selector page as start page
- [ ] available gui pages based on the currently active scene. Hide pages not needed in a scene
- [ ] make gui actions context sensitive for the currently active scene
Long term goals (not yet scheduled)
- [ ] Easier configuration - [ ] Easier configuration
- [ ] Document the current process of customization - [ ] Document the current process of customization
- [ ] Store the configuration in Flash (e.g. as a editable json file) - [ ] Store the configuration in Flash (e.g. as a editable json file)
- [ ] Add an interface for graphically editing the configuration - [ ] Add an interface for graphically editing the configuration
- [ ] Complete the on-device settings page
- [ ] Make the Wi-Fi connection more stable
See the [open issues](https://github.com/CoretechR/OMOTE/issues) and [discussions](https://github.com/CoretechR/OMOTE/discussions) for a full list of proposed features (and known issues). See the [open issues](https://github.com/CoretechR/OMOTE/issues) and [discussions](https://github.com/CoretechR/OMOTE/discussions) for a full list of proposed features (and known issues).
## Getting Started
OMOTE might look like a finished product, but especially the software is ***not "consumer-friendly"*** yet. If you want to build your own remote and customize it to your devices, you should be ***somewhat experienced with electronics and programming***.
### Simulator ### Simulator
You can try the user interface on your PC using the LVGL simulator. Just follow these steps: A simulator for running the UI on your local Windows or Linux machine will be released soon.
You can run the simulator in Visual Studio Code with PlatformIO. No need for any other compiler or development environment (no Visual Studio needed).
1. Install Visual Studio, including the "Desktop development with C++" workload. You can use the free Community edition.
2. Start Visual Studio and open LVGL.Simulator.sln
3. Make sure that the build target is set to x64 and then run the local Windows debugger.
### Hardware ### Hardware
@ -82,7 +87,9 @@ The [housing and buttons](https://github.com/CoretechR/OMOTE/tree/main/CAD) can
### Software ### Software
The remote can be charged and programmed via its USB-C port. Open the [PlatformIO project](https://github.com/CoretechR/OMOTE/tree/main/Platformio) to compile and upload the code to the ESP32. Within the code, you can edit the Wi-Fi settings and the button mapping. OMOTE features a IR-receiver which is not currently implemented in the code. You can still modify the [ESp8266-IRRemote RecvDump example](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/examples/IRrecvDumpV2/IRrecvDumpV2.ino) to read the codes from your TV remote. The remote can be charged and programmed via its USB-C port. Open the [PlatformIO project](https://github.com/CoretechR/OMOTE/tree/main/Platformio) to compile and upload the code to the ESP32.
Please see the [wiki on how to understand and modify the software.](https://github.com/CoretechR/OMOTE/wiki/How-to-understand-and-modify-the-software)
## Contributing ## Contributing