utilities: update the doc for is-05 by add a real use case

In the given example, also remove the useless json param for the receiver because it is hardcoded.
AMWA-TV · Aug 16, 2022 · d933bd3 · d933bd3
1 parent 0e01916
commit d933bd3
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 17 deletions.
diff --git a/utilities/is-05-control/README.md b/utilities/is-05-control/README.md
@@ -29,29 +29,38 @@ optional arguments:
   --version VERSION     Version of IS-05 API of DuT
   -s, --sender          Configure NMOS Sender
   -r, --receiver        Configure NMOS Receiver
-  --request REQUEST     JSON data to be sent in the request to configure
-                        sender
-  --sdp SDP             SDP file to be sent in the request to configure
-                        receiver
+  --request REQUEST     JSON data to be sent in the request to configure sender
+  --sdp SDP             SDP file to be queried from a Sender (write) or be sent to a Receiver (read)
   -u UUID, --uuid UUID  UUID of resource to be configured
 ```
 
-Example call to change receiver
+Inside the script the IS-05 device can be controlled with the following keys
 ```
-python3 is05Control.py --ip <hostname or IP> --port <IS-05 Port> --version <IS-05 Version> --receiver --uuid <Receiver ID> --request tune-receiver-to-reference.json --sdp video-1080i-7.sdp
+Press 'e' to set master_enable True
+Press 'd' to set master_enable False
+Press 'c' to set a valid config on a Sender (JSON) or a Receiver(SDP)
+Press 'u' to set a dummy config on a Sender (JSON) or a Receiver(SDP)
+Press '7' to set 2022-7 Sender to dummy config
+Press 's' to get SDP file (and save to "./toto.json" from a Sender)
+Waiting for input...
 ```
 
-Example call to enable sender
+## Example: create a media connection
+
+1. Connect to a sender:
+
 ```
-python3 is05Control.py --ip <hostname or IP> --port <IS-05 Port> --version <IS-05 Version> --sender --uuid <Sender ID> --request sender-to-20-1080i-7.json
+python3 is05Control.py --ip <hostname or IP> --port <IS-05 Port> --version <IS-05 Version> --sender --uuid <Sender ID> --request sender-to-20-1080i-7.json --sdp new.sdp
 ```
 
-Inside the script the IS-05 device can be controlled with the following keys
+2. Enable (`e`)
+3. Push a valid RTP config (`c`)
+4. Save SDP file (`s`)
+5. Connect to a receiver:
+
 ```
-Press 'e' to set master_enable True
-Press 'd' to set master_enable False
-Press 'c' to set Sender or Receiver to valid config
-Press 'u' to set Sender or Receiver to dummy config
-Press '7' to set 2022-7 Sender to dummy config
-Waiting for input...
+python3 is05Control.py --ip <hostname or IP> --port <IS-05 Port> --version <IS-05 Version> --receiver --uuid <Receiver ID> --sdp new.sdp
 ```
+
+6. Enable (`e`)
+7. Push the the new SDP (`c`)
diff --git a/utilities/is-05-control/is05Control.py b/utilities/is-05-control/is05Control.py
@@ -209,8 +209,8 @@ def send_request(url, body):
     while(True):
         print('\nPress \'e\' to set master_enable True')
         print('Press \'d\' to set master_enable False')
-        print('Press \'c\' to set Sender or Receiver to valid config')
-        print('Press \'u\' to set Sender or Receiver to dummy config')
+        print('Press \'c\' to set a valid config on a Sender (JSON) or a Receiver(SDP)')
+        print('Press \'u\' to set a dummy config on a Sender (JSON) or a Receiver(SDP)')
         print('Press \'7\' to set 2022-7 Sender to dummy config')
         print('Press \'s\' to get SDP file (and save to "./{}" from a Sender)'.format(sdp_filename))