Merge branch 'main' into lvgl-simulator

README.md

@@ -1,6 +1,6 @@
 # OMOTE - Open Universal Remote
 
-![](P1030424_small.jpg)
+![](images/P1030424_small.jpg)
 
 ![ESP32 Build](https://github.com/CoretechR/OMOTE/actions/workflows/build-platformio.yml/badge.svg)
 ![Simulator Build](https://github.com/CoretechR/OMOTE/actions/workflows/build-simulator.yml/badge.svg)
@@ -11,7 +11,7 @@
 OMOTE is an ESP32 based open source universal remote. Its capacitive 2.8” touchscreen provides an intuitive and snappy user interface for switching devices and settings. No hub or docking station is required as the remote features infrared, Wi-Fi and Bluetooth connectivity. With its well optimized power consumption, OMOTE can run for months on a charge. And since the design files are open source, you can fully customize them to your devices and needs.
 
 <div align="center">
-  <img src="Menu.gif" width="50%">
+  <img src="images/Menu.gif" width="50%">
 </div>
 
 ### Features
@@ -22,49 +22,33 @@ OMOTE is an ESP32 based open source universal remote. Its capacitive 2.8” touc
 * Press any button or simply lift the remote to wake it up
 * Up to 6 months of battery life using a 2000 mAh Li-Po battery 
 
-### Dependencies
+### The state of this project
 
-* [espressif32](https://github.com/platformio/platform-espressif32)@^6.1.0
-* [lvgl/lvgl](https://github.com/lvgl/lvgl)@^8.3.4
-* [bodmer/TFT_eSPI](https://github.com/Bodmer/TFT_eSPI)@^2.5.23
-* [sparkfun/SparkFun LIS3DH Arduino Library](https://github.com/sparkfun/SparkFun_LIS3DH_Arduino_Library)@^1.0.3
-* [crankyoldgit/IRremoteESP8266](https://github.com/crankyoldgit/IRremoteESP8266)@^2.8.4
-* [adafruit/Adafruit FT6206 Library](https://github.com/adafruit/Adafruit_FT6206_Library)@^1.0.6
-* [knolleary/PubSubClient](https://github.com/knolleary/PubSubClient)@^2.8
-* [Chris--A/Keypad](https://github.com/Chris--A/Keypad) (modified for inverted logic)
-
-### 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.
 
-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. 
-
-### To Do
-
-Currently I have no idea if and when this will be done. But these would be the next steps:
-
-- [ ] Easier configuration
-    - [ ] Document the current process of customization
-    - [ ] Store the configuration in Flash (e.g. as a editable json file)
-    - [ ] Add an interface for graphically editing the configuration
-- [ ] Complete the on-device settings page
-- [ ] Make the Wi-Fi connection more stable
+#### Software
+The software can be adjusted to your needs. You can add your own amplifier, TV and media player. Smart home devices can be controlled with MQTT. The software is an example made up of:
+* a TV and an amplifier controlled with infrared
+* a Fire TV media player controlled with BLE (bluetooth keyboard)
+* some smart home devices controlled with MQTT
+* an IR receiver for decoding the IR codes from your remote
 
-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).
+Please see the [wiki on how to understand and modify the software.](https://github.com/CoretechR/OMOTE/wiki/02-How-to-understand-and-modify-the-software)
 
-## Getting Started
+You need to have PlatformIO running, and you need to know how to compile and flash your own firmware with PlatformIO. There is no prebuild firmware.
 
-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***. 
+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.
 
-### Simulator
+As a long term goal, maybe a prebuild firmware will be published, where you can configure your OMOTE via a web interface.
 
-You can try the user interface on your PC using the LVGL simulator. Just follow these steps:
+### LVGL GUI simulator for Windows and Linux
 
-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.
+A simulator for running the LVGL 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 as often done in other LVGL simulators).
 
-### Hardware
+### Building the hardware
 
 The central component of OMOTE is its PCB. If you want to build the PCB yourself, you will need SMT-reflow tools like a hot plate or a hot-air station. The 2-layered board and a solder paste stencil can be ordered from any PCB manufacturer using the [KiCad files](https://github.com/CoretechR/OMOTE/tree/main/PCB). Manufacturers like OSHPARK or Aisler will accept these files directly. For JLCPCB or PCBWay, you can use their plugin to export the optimized Gerber files. A [zip archive](https://github.com/CoretechR/OMOTE/blob/main/PCB/production/gerber.zip) with theses Gerber files is also included in this repository.
 
@@ -75,14 +59,26 @@ The project uses a 2000mAh Li-Ion battery with a JST-PHR-2 connector. Any 3.7V L
 The 2.8" capacitive touchscreen can be sourced from Adafruit ([2770](https://www.adafruit.com/product/2770)). If you look for the part number CH280QV10-CT, you can also buy this display directly from the manufacturer via [Alibaba](https://www.alibaba.com/product-detail/High-Quality-240-3-rgb-320_1600408828330.html). Shipping from China is expensive, so this only makes sense if you order multiple displays. In general, the cost for a single OMOTE is quite high. Check out the buy-sell page on the [Discord](https://discord.com/channels/1138116475559882852/1153343867681243279) to see if you can share the cost of the PCBs and components with others.
 
 <div align="center">
-  <img src="parts.jpg" width="80%">
+  <img src="images/parts.jpg" width="80%">
 </div>
 
 The [housing and buttons](https://github.com/CoretechR/OMOTE/tree/main/CAD) can be printed using PLA or PETG. I sliced the models with PrusaSlicer with a layer height of 0.25mm and printed them using ColorFabb PETG. It is important that the case part is printed with its flat side towards the print bed using lots of support structures. If your printer is well calibrated, the cover plate will snap onto the case.
 
-### Software
+### To Dos for software
+
+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
+    - [ ] Document the current process of customization
+    - [ ] Store the configuration in Flash (e.g. as a editable json file)
+    - [ ] Add an interface for graphically editing the configuration
 
-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.
+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).
 
 ## Contributing