Update readme, add more examples

README.md

@@ -78,7 +78,9 @@ except IOError as e:
 
 ## Methods
 
-The CamillaConnection class provides the following methods:
+The CamillaConnection class provides the following methods
+
+### Basics
 
 | Method   |  Description  |
 |----------|---------------|
@@ -88,21 +90,13 @@ The CamillaConnection class provides the following methods:
 |`get_version()` | Read CamillaDSP version, returns a tuple with 3 elements|
 |`get_library_version()` | Read pyCamillaDSP version, returns a tuple with 3 elements|
 |`get_state()` | Get current processing state. Returns one of "RUNNING", "PAUSED" or "INACTIVE".|
-|`get_signal_range()` | Get current signal range.|
-|`get_signal_range_dB()` | Get current signal range in dB.|
-|`get_capture_signal_rms()` | Get capture signal level rms in dB. Full scale is 0 dB. Returns a list with one element per channel.|
-|`get_playback_signal_rms()` | Get playback signal level rms in dB. Full scale is 0 dB. Returns a list with one element per channel.|
-|`get_capture_signal_peak()` | Get capture signal level peak in dB. Full scale is 0 dB. Returns a list with one element per channel.|
-|`get_playback_signal_peak()` | Get playback signal level peak in dB. Full scale is 0 dB. Returns a list with one element per channel.|
-|`get_volume()` | Get current volume setting in dB.|
-|`set_volume(value)` | Set volume in dB.|
-|`get_capture_rate_raw()` | Get current capture rate, raw value.|
-|`get_capture_rate()` | Get current capture rate. Returns the nearest common value.|
-|`get_update_interval()` | Get current update interval in ms.|
-|`set_update_interval(value)` | Set current update interval in ms.|
-|`get_rate_adjust()` | Get current value for rate adjust.|
 |`stop()` | Stop processing and wait for new config if wait mode is active, else exit. |
 |`exit()` | Stop processing and exit.|
+
+
+### Config handling
+| Method   |  Description  |
+|----------|---------------|
 |`reload()` | Reload config from disk.|
 |`get_config_name()` | Get path to current config file.|
 |`set_config_name(value)` | Set path to config file.|
@@ -114,10 +108,46 @@ The CamillaConnection class provides the following methods:
 |`read_config_file(path)` | Read a config file from `path`. Returns the loaded config with all optional fields filled with defaults. Raises a CamillaError on errors.|
 |`read_config(config)` | Read a config from yaml string and return the contents as an obect, with defaults filled out with their default values.|
 
+### Reading status
+| Method   |  Description  |
+|----------|---------------|
+|`get_signal_range()` | Get current signal range.|
+|`get_signal_range_dB()` | Get current signal range in dB.|
+|`get_capture_signal_rms()` | Get capture signal level rms in dB. Full scale is 0 dB. Returns a list with one element per channel.|
+|`get_playback_signal_rms()` | Get playback signal level rms in dB. Full scale is 0 dB. Returns a list with one element per channel.|
+|`get_capture_signal_peak()` | Get capture signal level peak in dB. Full scale is 0 dB. Returns a list with one element per channel.|
+|`get_playback_signal_peak()` | Get playback signal level peak in dB. Full scale is 0 dB. Returns a list with one element per channel.|
+|`get_capture_rate_raw()` | Get current capture rate, raw value.|
+|`get_capture_rate()` | Get current capture rate. Returns the nearest common value.|
+|`get_update_interval()` | Get current update interval in ms.|
+|`set_update_interval(value)` | Set current update interval in ms.|
+|`get_rate_adjust()` | Get current value for rate adjust.|
+|`get_buffer_level()` | Get current buffer level of the playback device.|
+|`get_clipped_samples()` | Get number of clipped samples since the config was loaded.|
+
+### Volume control
+| Method   |  Description  |
+|----------|---------------|
+|`get_volume()` | Get current volume setting in dB.|
+|`set_volume(value)` | Set volume in dB.|
 
 # Included examples:
 
-play_wav: Play a wav file. This example reads a configuration from a file, updates the capture device fto point at a given .wav file, and sends this modified config to CamillaDSP.
+## read_rms
+Read the playback signal level continuously and print in the terminal, until stopped by Ctrl+c. 
+```sh
+python read_rms.py 1234
+```
+
+## set_volume
+Set the volume control to a new value. First argument is websocket port, second is new volume in dB.
+For this to work, CamillaDSP must be running a configuration that has Volume filters in the pipeline for every channel.
+```sh
+python set_volume.py 1234 -12.3
+```
+
+## play_wav
+Play a wav file. This example reads a configuration from a file, updates the capture device fto point at a given .wav file, and sends this modified config to CamillaDSP.
 Usage example:
 ```sh
 python play_wav.py 1234 /path/to/wavtest.yml /path/to/music.wav

examples/read_rms/read_rms.py

@@ -0,0 +1,22 @@
+# play wav
+from camilladsp import CamillaConnection
+import sys
+import time
+
+try:
+    port = int(sys.argv[1])
+except:
+    print("Usage: start CamillaDSP with the socketserver enabled:")
+    print("> camilladsp -p4321 yourconfig.yml")
+    print("Then read the signal level")
+    print("> python read_rms.py 4321")
+    sys.exit()
+
+cdsp = CamillaConnection("127.0.0.1", port)
+cdsp.connect()
+
+print("Reading playback signal RMS, press Ctrl+c to stop")
+while True:
+    print(cdsp.get_playback_signal_rms())
+    time.sleep(1)
+

examples/set_volume/set_volume.py

@@ -0,0 +1,24 @@
+# play wav
+from camilladsp import CamillaConnection
+import sys
+import time
+
+try:
+    port = int(sys.argv[1])
+    new_vol = float(sys.argv[2])
+except:
+    print("Usage: Make sure that your pipeline includes Volume filters for each channel.")
+    print("Then start CamillaDSP with the websocket server enabled:")
+    print("> camilladsp -p4321 yourconfig.yml")
+    print("Then set the volume")
+    print("> python read_rms.py 4321 -12.3")
+    sys.exit()
+
+cdsp = CamillaConnection("127.0.0.1", port)
+cdsp.connect()
+
+current_vol = cdsp.get_volume()
+print(f"Current volume: {current_vol} dB")
+print(f"Changing volume to: {new_vol} dB")
+cdsp.set_volume(new_vol)
+