Commit 9b4bf4c8 authored by Joel Collins's avatar Joel Collins
Browse files

Moved status routes to instrument/state

parent e9e2419f

docs/source/extensions/example_extension/03_marshaling_data.py

+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ from labthings.server import fields 
class MicroscopeIdentifySchema(Schema):

    name = fields.String()  # Microscopes name

    id = fields.UUID()  # Microscopes unique ID

    status = fields.Dict()  # Status dictionary

    state = fields.Dict()  # Status dictionary

    camera = fields.String()  # Camera object (represented as a string)

    stage = fields.String()  # Stage object (represented as a string)

docs/source/extensions/example_extension/04_properties.py

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ from labthings.server import fields 
class MicroscopeIdentifySchema(Schema):

    name = fields.String()  # Microscopes name

    id = fields.UUID()  # Microscopes unique ID

    status = fields.Dict()  # Status dictionary

    state = fields.Dict()  # Status dictionary

    camera = fields.String()  # Camera object (represented as a string)

    stage = fields.String()  # Stage object (represented as a string)

docs/source/extensions/example_extension/05_actions.py

+1 −1
Original line number Diff line number Diff line
@@ -24,7 +24,7 @@ import io # Used in our capture action 
class MicroscopeIdentifySchema(Schema):

    name = fields.String()  # Microscopes name

    id = fields.UUID()  # Microscopes unique ID

    status = fields.Dict()  # Status dictionary

    state = fields.Dict()  # Status dictionary

    camera = fields.String()  # Camera object (represented as a string)

    stage = fields.String()  # Stage object (represented as a string)

docs/source/extensions/marshaling.rst

+1 −1
Original line number Diff line number Diff line
@@ -107,7 +107,7 @@ We start by creating a schema to describe how to serialise a :py:class:`openflex 
    class MicroscopeIdentifySchema(Schema):

        name = fields.String()  # Microscopes name

        id = fields.UUID()  # Microscopes unique ID

        status = fields.Dict()  # Status dictionary

        state = fields.Dict()  # Status dictionary

        camera = fields.String()  # Camera object (represented as a string)

        stage = fields.String()  # Stage object (represented as a string)

openflexure_microscope/api/app.py

+12 −10
Original line number Diff line number Diff line
@@ -94,16 +94,18 @@ labthing.add_view(views.CaptureDownload, f"/captures/<id>/download/<filename>") 
labthing.add_view(views.CaptureTags, f"/captures/<id>/tags")

labthing.add_view(views.CaptureAnnotations, f"/captures/<id>/annotations")



# Attach settings and status resources

labthing.add_view(views.SettingsProperty, f"/settings")

labthing.add_root_link(views.SettingsProperty, "settings")

labthing.add_view(views.NestedSettingsProperty, "/settings/<path:route>")

labthing.add_view(views.StatusProperty, "/status")

labthing.add_view(views.NestedStatusProperty, "/status/<path:route>")

labthing.add_root_link(views.StatusProperty, "status")

labthing.add_view(views.ConfigurationProperty, "/configuration")

labthing.add_view(views.NestedConfigurationProperty, "/configuration/<path:route>")

labthing.add_root_link(views.ConfigurationProperty, "configuration")

# Attach settings and state resources

labthing.add_view(views.SettingsProperty, f"/instrument/settings")

labthing.add_root_link(views.SettingsProperty, "instrumentSettings")

labthing.add_view(views.NestedSettingsProperty, "/instrument/settings/<path:route>")

labthing.add_view(views.StateProperty, "/instrument/state")

labthing.add_view(views.NestedStateProperty, "/instrument/state/<path:route>")

labthing.add_root_link(views.StateProperty, "instrumentState")

labthing.add_view(views.ConfigurationProperty, "/instrument/configuration")

labthing.add_view(

    views.NestedConfigurationProperty, "/instrument/configuration/<path:route>"

)

labthing.add_root_link(views.ConfigurationProperty, "instrumentConfiguration")





# Attach streams resources