From 9d49afa5a822548b975f00d8b51ba9256b59fb62 Mon Sep 17 00:00:00 2001 From: occheung Date: Tue, 29 Sep 2020 17:05:11 +0800 Subject: [PATCH] readme: tiny format change --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 98a257d..3923101 100644 --- a/README.md +++ b/README.md @@ -85,23 +85,26 @@ publish-mqtt Foo/Bar "baz" ## List of Commands All currently supported commands are listed below. **Note: The following table only lists the subtopic. To make a full topic, add `Urukul/Control/` in front of all subtopics.** -Example: Full topic of Reset command: `Urukul/Control/Reset` +### Example: Full topic of Reset command +```shell +Urukul/Control/Reset +``` -| Subtopic| Message| Functionality| -| ---| ---| ---| -| `Reset`| | Reset the device| -| `ChannelX/Switch`| ``| Turn off/on the RF switch at channel X.| -| `ChannelX/Attenuation`| ` [dB]`| Set attenuation of channel X.| -| `Clock/Source`| ``| Select the clock source of Urukul.| -| `Clock/Frequency`| ` [unit]`| Set the clock frequency of the clock source of Urukul.| -| `Clock/Source`| ``| Set the clock division of Urukul.| -| `Clock`| `frequency: [unit], source: , division: `| Setup the clock tree for Urukul.| -| `ChannelX/SystemClock`| ` [unit]`| Set the system clock frequency of channel X.| -| `ChannelX/ProfileY/Singletone/Frequency`| ` [unit]`| Setup a single tone profile at channel X, profile Y, with frequency ` [unit]`.| -| `ChannelX/ProfileY/Singletone/Amplitude`| ``| Setup a single tone profile at channel X, profile Y, with amplitude factor ``.| -| `ChannelX/ProfileY/Singletone/Phase`| ` [deg]`| Setup a single tone profile at channel X, profile Y, with phase ` [deg]`.| -| `ChannelX/ProfileY/Singletone`| `frequency: [unit], amplitude: , phase: `| Setup a compelte single tone profile at channel X, profile Y.| -| `Profile`| ``| Switch to a DDS profile across all channels.| +| Subtopic | Message | Functionality| +| --------------------------------------- | ------------------------------------------------------------------ | ---| +| `Reset` | | Reset the device| +| `ChannelX/Switch` | `` | Turn off/on the RF switch at channel X.| +| `ChannelX/Attenuation` | ` [dB]` | Set attenuation of channel X.| +| `Clock/Source` | `` | Select the clock source of Urukul.| +| `Clock/Frequency` | ` [unit]` | Set the clock frequency of the clock source of Urukul.| +| `Clock/Source` | `` | Set the clock division of Urukul.| +| `Clock` | `frequency: [unit], source: , division: `| Setup the clock tree for Urukul.| +| `ChannelX/SystemClock` | ` [unit]` | Set the system clock frequency of channel X.| +| `ChannelX/ProfileY/Singletone/Frequency`| ` [unit]` | Setup a single tone profile at channel X, profile Y, with frequency ` [unit]`.| +| `ChannelX/ProfileY/Singletone/Amplitude`| `` | Setup a single tone profile at channel X, profile Y, with amplitude factor ``.| +| `ChannelX/ProfileY/Singletone/Phase` | ` [deg]` | Setup a single tone profile at channel X, profile Y, with phase ` [deg]`.| +| `ChannelX/ProfileY/Singletone` | `frequency: [unit], amplitude: , phase: ` | Setup a compelte single tone profile at channel X, profile Y.| +| `Profile` | `` | Switch to a DDS profile across all channels.| ## Reset the device - Topic: `Urukul/Control/Reset`