Merge branch 'master' of https://github.com/custom-components/pyscript

Author: craigbarratt

custom_components/pyscript/services.yaml

@@ -1,42 +1,107 @@
 # Describes the format for available pyscript services
 
 reload:
-  description: Reload all available pyscripts and restart triggers
+  name: Reload pyscript
+  description: Reloads all available pyscripts and restart triggers
   fields:
     global_ctx:
-      description: only reload this specific global context (file or app)
+      name: Global Context
+      description: Only reload this specific global context (file or app)
       example: file.example
+      required: false
+      selector:
+        text:
 
 jupyter_kernel_start:
-  description: Start a jupyter kernel for interactive use; called by Jupyter front end
+  name: Start Jupyter kernel
+  description: Starts a jupyter kernel for interactive use; Called by Jupyter front end and should generally not be used by users
   fields:
     shell_port:
-      description: shell port number
+      name: Shell Port Number
+      description: Shell port number
       example: 63599
+      required: false
+      selector:
+        number:
+          min: 10240
+          max: 65535
     iopub_port:
-      description: iopub port number
+      name: IOPub Port Number
+      description: IOPub port number
       example: 63598
+      required: false
+      selector:
+        number:
+          min: 10240
+          max: 65535
     stdin_port:
-      description: stdin port number
+      name: Stdin Port Number
+      description: Stdin port number
       example: 63597
+      required: false
+      selector:
+        number:
+          min: 10240
+          max: 65535
     control_port:
-      description: control port number
+      name: Control Port Number
+      description: Control port number
       example: 63596
+      required: false
+      selector:
+        number:
+          min: 10240
+          max: 65535
     hb_port:
-      description: heartbeat port number
+      name: Heartbeat Port Number
+      description: Heartbeat port number
       example: 63595
+      required: false
+      selector:
+        number:
+          min: 10240
+          max: 65535
     ip:
-      description: ip address to connect to jupyter front end
+      name: IP Address
+      description: IP address to connect to Jupyter front end
       example: 127.0.0.1
+      default: 127.0.0.1
+      required: false
+      selector:
+        text:
     key:
-      description: security key for signing
+      name: Security Key
+      description: Used for signing
       example: 012345678-9abcdef023456789abcdef
+      required: true
+      selector:
+        text:
     transport:
-      description: type of transport
+      name: Transport Type
+      description: Transport type
       example: tcp
+      default: tcp
+      required: false
+      selector:
+        select:
+          options:
+            - tcp
+            - udp
     signature_scheme:
-      description: signing algorithm
+      name: Signing Algorithm
+      description: Signing algorithm
       example: hmac-sha256
+      required: false
+      default: hmac-sha256
+      selector:
+        select:
+          options:
+            - hmac-sha256
     kernel_name:
-      description: name of kernel
+      name: Name of Kernel
+      description: Kernel name
       example: pyscript
+      required: true
+      default: pyscript
+      selector:
+        text:

docs/reference.rst

@@ -941,21 +941,33 @@ description that appears is in the Services tab of the Developer Tools page. The
 names are used as the service parameter names, but there is no description.
 
 Alternatively, if the ``doc_string`` starts with ``yaml``, the rest of the string is used as a
-``yaml`` service description. Here's the first example above, with a more detailed ``doc_string``:
+``yaml`` service description. Here's the first example above, with a more detailed ``doc_string``
+(for a more complete example and explanation of the service description, check the Home Assistant
+`developer documentation <#https://developers.home-assistant.io/docs/dev_101_services#service-descriptions>`__):
 
 .. code:: python
 
    @service
    def hello_world(action=None, id=None):
        """yaml
+   name: Service example
    description: hello_world service example using pyscript.
    fields:
      action:
         description: turn_on turns on the light, fire fires an event
         example: turn_on
+        required: true
+        selector:
+          select:
+            options:
+              - turn_on
+              - fire
      id:
         description: id of light, or name of event to fire
         example: kitchen.light
+        required: true
+        selector:
+          text:
    """
        log.info(f"hello world: got action {action}")
        if action == "turn_on" and id is not None: