Updated examples

Author: Joel Collins

examples/builder.py

@@ -7,6 +7,7 @@
 import logging
 
 from labthings.server.quick import create_app
+from labthings.server import fields
 
 from components.pdf_component import PdfComponent
 
@@ -33,21 +34,33 @@
     "magic_denoise",  # Objects attribute name
     "/denoise",  # URL to bind the property to
     description="A magic denoise property",
+    schema=fields.Int(example=200),  # Property should be integer formatted
 )
 
 labthing.build_property(
     my_component,  # Python object
     "magic_dictionary",  # Objects attribute name
     "/dictionary",  # URL to bind the property to
     description="A big dictionary of little properties",
+    schema={  # Property is a dictionary, with these value types
+        "voltage": fields.Int(),
+        "volume": fields.List(fields.Int()),
+        "mode": fields.String(),
+        "light_on": fields.Bool(),
+        "user": {"name": fields.String(), "id": fields.Int()},
+        "bytes": fields.Bytes(),
+    },
 )
 
 labthing.build_action(
     my_component.average_data,  # Python function
     "/average",  # URL to bind the action to
     description="Take an averaged measurement",
     safe=True,  # Is the state of the Thing unchanged by calling the action?
-    idempotent=True,  # Can the action be called repeatedly with the same result?
+    idempotent=True,  # Can the action be called repeatedly with the same result?,
+    args={  # How do we convert from the request input to function arguments?
+        "n": fields.Int(description="Number of averages to take", example=5, default=5)
+    },
 )
 
 

examples/components/pdf_component.py

@@ -2,8 +2,6 @@
 import math
 import time
 
-from typing import List
-
 """
 Class for our lab component functionality. This could include serial communication,
 equipment API calls, network requests, or a "virtual" device as seen here.
@@ -41,7 +39,7 @@ def data(self):
         """Return a 1D data trace."""
         return [self.noisy_pdf(x) for x in self.x_range]
 
-    def average_data(self, n: int, optlist: List[int] = [1, 2, 3]):
+    def average_data(self, n: int):
         """Average n-sets of data. Emulates a measurement that may take a while."""
         summed_data = self.data