Skip to content

Commit 35b189e

Browse files
mathertelmathertel
authored
Merge pull request #45 from mathertel/feature_Si4721
Feature Si4721 for receiving and transmitting. Much help from NPoole and sparkfun for supporting a board . See [README.md](README.md) and [CHANGELOG.MD](CHANGELOG.MD)
2 parents 32e019f + 33acfde commit 35b189e

21 files changed

+2445
-726
lines changed

‎.gitignore

+6-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,9 @@
1818
# Executables
1919
*.exe
2020
*.out
21-
*.app
21+
*.app
22+
23+
/temp
24+
/.vscode
25+
/.development
26+
_*

‎CHANGELOG.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [2.0.0] - 2020-09-17
6+
7+
> **Important changes**
8+
>
9+
> This release focuses adding the si4721 radio chip to the library. The adoption was done using the board from sparkfun you can find here:
10+
> <https://www.sparkfun.com/products/15853>.
11+
>
12+
> This chip also supports sending FM signals, there is a special example 'TransmitSI4721.ino' to show this functionality.
13+
14+
Thanks to [@NPoole](https://github.com/NPoole) for adding the adoption of the si4721 chip.
15+
16+
17+
### Added Examples
18+
19+
* **[TestSI4721.ino](/examples/TestSI4721/TestSI4721.md)** - This is the simple fixed settings example to proof correct functionality and wiring.
20+
21+
* **[TransmitSI4721.ino](/examples/TransmitSI4721/TransmitSI4721.md)** - This example shows how to implement FM transmission using the SI4721 chip. Please respect your local radio transmission policies and rules by your govermant.
22+
23+
24+
25+
### Enhancements
26+
27+
* The base radio class implementations now has some I2c utility routings that will be further adopted in the chip libraries.
28+
* Some code to initialize the I2C bus has beed added to the examples to support ESP8266 boards.
29+
30+
### Fixes
31+
32+
With some chips that support multiple modes the power up should be handles when specifying the mode in setBand and power situation will be handled according the following schema:
33+
34+
* The init() function establishes communication with the radio chip. As a result the radio chip will not yet work and is in power down state.
35+
* The setBand() function will configure the radio chip and start operation. The radio chip will be in power up state.
36+
* The term() function will stop any operation. The radio chip will be in power down state. Communication with the chip will still work.
37+
* To implement a "standby" functionality setBand() for "on" and term() for "standby" should be used.
38+
39+
This is verified for SI4721 for now.
40+
41+
42+
### Known Issues
43+
44+
The TransmitSI4721.ino example and the library doesn't offer all options for transmitting but some basic functionality.
45+
Improvements are welcome.
46+
47+
---
48+
49+
## Notes
50+
51+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
52+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) as used for the Arduino libraries.
53+

‎LICENSE

+24-9
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
1-
See http://www.mathertel.de/License.aspx
1+
BSD 3-Clause License
22

3-
Software License Agreement (BSD License)
4-
5-
Copyright (c) 2005-2014 by Matthias Hertel, http://www.mathertel.de/
3+
Copyright (c) 2005-2020, Matthias Hertel, http://www.mathertel.de/
64

75
All rights reserved.
86

9-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are met:
9+
10+
1. Redistributions of source code must retain the above copyright notice, this
11+
list of conditions and the following disclaimer.
12+
13+
2. Redistributions in binary form must reproduce the above copyright notice,
14+
this list of conditions and the following disclaimer in the documentation
15+
and/or other materials provided with the distribution.
1016

11-
�Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
12-
�Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
13-
�Neither the name of the copyright owners nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
17+
3. Neither the name of the copyright holder nor the names of its
18+
contributors may be used to endorse or promote products derived from
19+
this software without specific prior written permission.
1420

15-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md

+40-14
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,63 @@
22

33
This library is about controlling an FM radio chips by using an Arduino board and some optional components like a LCD display, a rotary encoder, a LCD+Keyboard shield or an Ethernet Shield to build a standalone radio.
44

5-
In the [mathertel / Radio](https://github.com/mathertel/Radio) repository on github.com you find an Arduino library for implementing an FM receiver using one of the supported radio chips for receiving FM broadcast audio signals.
5+
In the [mathertel/Radio](https://github.com/mathertel/Radio) repository on github.com you find an Arduino library for implementing an FM receiver using one of the supported radio chips for receiving FM broadcast audio signals.
66

77
There are various examples included that show using the library using different hardware setups.
88

9+
The library is working for many boards like Arduino, Arduino Mega, ESP8266 and maybe more.
10+
11+
See also the [Changelog](CHANGELOG.md).
12+
913
## Documentation
1014

11-
The documentation for the libraries in DOXYGEN style can be found at [http://mathertel.github.io/Radio/html](html/index.html).
15+
The API documentation for the libraries in DOXYGEN style can be found at [http://mathertel.github.io/Radio/html](html/index.html).
1216

13-
A more detailed article is availabe at [www.mathertel.de/Arduino/RadioLibrary.aspx](http://www.mathertel.de/Arduino/RadioLibrary.aspx).
17+
A more detailed article is available at [www.mathertel.de/Arduino/RadioLibrary.aspx](http://www.mathertel.de/Arduino/RadioLibrary.aspx).
1418

15-
Currently the following chips are supported:
19+
Currently the following radio receiver chips are supported:
1620

17-
* The RDA5807M from RDA Microelectronics
18-
* The SI4703 from Silicon Labs
19-
* The SI4705 from Silicon Labs
20-
* The TEA5767 from NXP
21+
* The **RDA5807M** from RDA Microelectronics
22+
* The **SI4703** from Silicon Labs
23+
* The **SI4705** from Silicon Labs
24+
* The **SI4721** from Silicon Labs
25+
* The **TEA5767** from NXP
2126

2227
They all are capable for receiving FM radio stations in stereo with European and US settings and can be controlled by using the I2C bus. However there are differences in the sensitivity and quality and well on receiving RDS information from the stations.
2328

2429
For each of these chips a specific library is implemented that knows how to communicate with the chip using the I2C bus and the wire library. These libraries all share a common base, the radio library so that all the common code is only implemented once in there:
2530

2631
All the libraries share the same interface (defined by the radio library) so it is possible to exchange them when not using one of the chip specific functions.
2732

33+
Currently the following radio transmitter chips are supported:
34+
35+
* The **SI4721** from Silicon Labs
36+
37+
38+
## Contributions
39+
40+
Contributions to the library like features, fixes and support of other chips and boards are welcome using Pull Requests.
41+
42+
Please don't ask general programming questions in this project. Radio chip specific questions may be answered by the community (or not) and are closed after some months of inactivity.
43+
2844
## Examples
2945

30-
Within the Arduino library you can find examples that implement different scenarios to control the radio chips:
46+
Within the Arduino library you can find examples that implement different scenarios to control various radio chips.
47+
48+
The basic examples only startup the chips and set a static station and volume:LCDKeypadRadio
49+
* **TestRDA5807M** to test the RDA5807M chip.
50+
* **TestSI4703** to test the SI4703 chip.
51+
* **TestSI4705** to test the SI4705 chip.
52+
* **TestSI4721** to test the SI4721 chip.
53+
* **TestTEA5767** to test the TEA5767 chip.
54+
55+
The examples can be used with several chips:
3156

32-
* The basic examples only startup the chips and set a static station and volume.
33-
* The SerialRadio example needs only an arduino and uses the Serial in- and output to change the settings and report information.
34-
* The LCDRadio example is similar to SerialRadio but also populates some information to an attached LCD.
35-
* The LCDKeypadRadio example uses the popular LCDKeypad shield.
36-
* The WebRadio example is the most advanced radio that runs on an Arduino Mega with an Ethernet Shield and an rotator encoder. You can also control the radio by using a web site that is available on the Arduino.
57+
* The **SerialRadio** example needs only an arduino and uses the Serial in- and output to change the settings and report information.
58+
* The **ScanRadio** is similar to the SerialRadio example but includes some experimental scanning approaches.
59+
* The **LCDRadio** example is similar to SerialRadio but also populates some information to an attached LCD.
60+
* The **LCDKeypadRadio** example uses the popular LCDKeypad shield.
61+
* The **WebRadio** example is the most advanced radio that runs on an Arduino Mega with an Ethernet Shield and an rotator encoder. You can also control the radio by using a web site that is available on the Arduino.
3762

63+
The only sending example for the SI4721 chip can be found in **TransmitSI4721**.
3864

‎examples/LCDKeypadRadio/LCDKeypadRadio.ino

+4-3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
#include <rda5807M.h>
4343
#include <si4703.h>
4444
#include <si4705.h>
45+
#include <si4721.h>
4546
#include <tea5767.h>
4647

4748
#include <RDSParser.h>
@@ -90,7 +91,8 @@ int i_sidx=5; ///< Start at Station with index=5
9091
// RADIO radio; ///< Create an instance of a non functional radio.
9192
// RDA5807M radio; ///< Create an instance of a RDA5807 chip radio
9293
// SI4703 radio; ///< Create an instance of a SI4703 chip radio.
93-
SI4705 radio; ///< Create an instance of a SI4705 chip radio.
94+
// SI4705 radio; ///< Create an instance of a SI4705 chip radio.
95+
SI4721 radio; ///< Create an instance of a SI4721 chip radio.
9496
// TEA5767 radio; ///< Create an instance of a TEA5767 chip radio.
9597

9698

@@ -234,7 +236,7 @@ void setup() {
234236

235237
radio.setMono(false);
236238
radio.setMute(false);
237-
// radio.debugRegisters();
239+
// radio._wireDebug();
238240
radio.setVolume(8);
239241

240242
Serial.write('>');
@@ -307,4 +309,3 @@ void loop() {
307309
} // loop
308310

309311
// End.
310-

0 commit comments

Comments
 (0)