Skip to content

Home

Jump to bottom
Resinchem edited this page Dec 3, 2023 · 3 revisions

Overview and Caveats

SI4703

This project primarily provides wrapper functions for WiFi, OTA Updates and MQTT to the RADIO library developed and maintained by mathertel. For details, questions, comments or issues related to use of the radio library, please see his repo. I'm just adding the wrapper functions and cannot or am unable to address issues with the radio library itself.

My particular version here is developed for the SI4703 FM receiver chip. The RADIO library supports many other types of FM receivers. If you wish to use a different FM receiver, please refer to the RADIO library for how to enable those in the code.

This version was primarily developed as a precursor step for my own DIY amp project. It is only be shared here as an example for adding MQTT to the radio library.

For this reason, all information in this repo is being provided AS-IS! I do not plan on making any further changes or revisions to this code... it is primarily here just to provide examples, although it can theoretically be used to create an exact copy.

For these reasons, I will not be accepting PRs, addressing issues or fulfilling any enhancement requests!

With that in mind, please see the following caveats and limitations:

  • The code was written for, and tested with, the Wemos D1 Mini. It should theoretically work with any ESP8266 board, but this has not been tested.

  • The code contains preprocessor directives to also work with an ESP32. It was confirmed to work with the ESP32 mini, but only cursory testing was done. There may or may not be issues with the ESP32.

  • As written, MQTT is technically not required, but seeing as this is the primary purpose of this repo, if you do not need MQTT (or WiFi connectivity), you'd be better off just using the RADIO library directly.

  • Installation requires use of the Arduino IDE (or other compatible system that can flash an .ino sketch to the ESP). Basic understanding of the Arduino IDE, including installing additional boards and libraries as needed, will be required for the intial flashing of the code.

  • Development was done using v1.8.16 of the Arduino IDE, as some libraries still have issues with v2.x of the IDE. Compilation may or may not be possible using v2.x, but I have not tested it.

If you wish to create a version for a different board or make another enhancements or changes, you should clone or fork this repo. The code is well documented and other sections of this wiki will provide additional information.

To learn more about this particular project, including see some of the features, please refer to the following video:

If you have any questions or comments about this project, please post them in the comments area of the video.

Clone this wiki locally