aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorScott Murray <scott.murray@konsulko.com>2020-10-05 17:03:30 -0400
committerScott Murray <scott.murray@konsulko.com>2020-10-06 15:06:59 -0400
commit8958a8a3e98085c60c9cd803395be157e78e3565 (patch)
treeee39f007112c4b6fc08db737554989bed4f28c3a /README.md
parentf00649ae4ab49f6f8faa26e7fdaae43615e3eb96 (diff)
Fix frequency verb invalid frequency behavior
The frequency verb was not checking if a frequency corresponds to the frequency band step the binding provides to users, add logic to do so and return an error if the frequency is invalid. While this is a change in behavior, it is believe it should not impact users, as the binding is intended to reflect user facing radio application usage. Additional tweaks: - fix error invalid frequency error message in reply JSON. - add the same band limit checks to the null implementation's frequency setting function that the other implementations do. - fix a couple of issues in README.md; the "rds" verb was missing, and the value key name for the "frequency" event was incorrect. Bug-AGL: SPEC-3620 Signed-off-by: Scott Murray <scott.murray@konsulko.com> Change-Id: I2adfc10448546264110f6d854f02d677087f1e47
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2155649..90184b7 100644
--- a/README.md
+++ b/README.md
@@ -21,12 +21,13 @@ respective audio stream.
| scan_start | start scanning for station | *Request:* {"direction": "forward" or "backward"} |
| scan_stop | stop scanning for station | |
| stereo_mode | get/set stereo or mono mode | *Request:* {"value": "stereo" or "mono"} |
+| rds | get current RDS data | |
## Events
### frequency Event JSON Response
-JSON response has a single field **frequency** which is the currently tuned frequency.
+JSON response has a single field **value** which is the currently tuned frequency.
### station_found Event JSON Response