Merge branch 'mccs-396' into 'master'

[SP-1501] State models, commands and component managers

See merge request ska-telescope/ska-tango-base!48

docs/source/api/csp/obs/component_manager.rst

+=========================
+CSP obs component manager
+=========================
+
+.. automodule:: ska_tango_base.csp.obs.component_manager
+   :members:

docs/source/api/csp/obs/index.rst

+==================
+CSP obs subpackage
+==================
+
+.. automodule:: ska_tango_base.csp.obs
+
+
+.. toctree::
+
+  CSP Obs State Model<obs_state_model>
+  CSP Obs Component Manager<component_manager>
+  Reference CSP Obs Component Manager<reference_component_manager>
+  CSP Obs device<obs_device>

docs/source/api/csp/obs/obs_device.rst

+=========================
+CSP Subelement Obs device
+=========================
+
+.. automodule:: ska_tango_base.csp.obs.obs_device
+   :members:

docs/source/api/csp/obs/obs_state_machine.uml

+IDLE: The subarray is unconfigured
+CONFIGURING_IDLE: The subarray is unconfigured;\nis performing a configuring operation
+CONFIGURING_READY: The subarray is configured;\nis performing a configuring operation
+READY: The subarray is configured
+SCANNING: The subarray is scanning
+ABORTING: The subarray is aborting
+ABORTED: The subarray has aborted
+RESETTING: The subarray is resetting to IDLE\nfrom FAULT or ABORTED state
+FAULT: The subarray has faulted
+
+IDLE -down-> CONFIGURING_IDLE: configure_invoked
+IDLE -left-> ABORTING: abort_invoked
+CONFIGURING_IDLE -up-> IDLE: configure_completed
+CONFIGURING_IDLE -down-> CONFIGURING_READY: component_configured
+CONFIGURING_IDLE -left-> ABORTING: abort_invoked
+CONFIGURING_READY -down-> READY: configure_completed
+CONFIGURING_READY -left-> ABORTING: abort_invoked
+READY -up-> CONFIGURING_READY: configure_invoked
+READY -up-> IDLE: component_unconfigured
+READY -down-> SCANNING: component_scanning
+READY -left-> ABORTING: abort_invoked
+SCANNING -up-> READY: component_not_scanning
+SCANNING -left-> ABORTING: abort_invoked
+ABORTING -up-> ABORTED: abort_completed
+ABORTED -up-> RESETTING: obsreset_invoked
+RESETTING -down-> ABORTING: abort_invoked
+RESETTING -right-> IDLE: obsreset_completed
+[*] -up-> FAULT: component_obsfault\n(from any state)
+FAULT -up-> RESETTING: obsreset_invoked

docs/source/api/csp/obs/obs_state_model.rst

+==============================
+CSP Subelement Obs State Model
+==============================
+
+.. automodule:: ska_tango_base.csp.obs.obs_state_model
+   :members:

docs/source/api/csp/obs/obs_state_model.uml

+IDLE: The subarray is unconfigured
+CONFIGURING: The subarray is performing a configuring operation
+READY: The subarray is configured
+SCANNING: The subarray is scanning
+ABORTING: The subarray is aborting
+ABORTED: The subarray has aborted
+RESETTING: The subarray is resetting to IDLE\nfrom FAULT or ABORTED state
+FAULT: The subarray has faulted
+
+IDLE -down-> CONFIGURING: configure_invoked
+IDLE -left-> ABORTING: abort_invoked
+CONFIGURING -up-> IDLE: configure_completed
+CONFIGURING -left-> ABORTING: abort_invoked
+CONFIGURING -down-> READY: configure_completed
+CONFIGURING -left-> ABORTING: abort_invoked
+READY -up-> CONFIGURING: configure_invoked
+READY -up-> IDLE: component_unconfigured
+READY -down-> SCANNING: component_scanning
+READY -left-> ABORTING: abort_invoked
+SCANNING -up-> READY: component_not_scanning
+SCANNING -left-> ABORTING: abort_invoked
+ABORTING -up-> ABORTED: abort_completed
+ABORTED -up-> RESETTING: obsreset_invoked
+RESETTING -down-> ABORTING: abort_invoked
+RESETTING -right-> IDLE: obsreset_completed
+[*] -up-> FAULT: component_obsfault\n(from any state)
+FAULT -up-> RESETTING: obsreset_invoked

docs/source/api/csp/obs/reference_component_manager.rst

+===================================
+Reference CSP Obs Component Manager
+===================================
+
+.. automodule:: ska_tango_base.csp.obs.reference_component_manager
+   :members:

docs/source/api/csp/subarray/component_manager.rst

+==============================
+CSP Subarray Component Manager
+==============================
+
+.. automodule:: ska_tango_base.csp.subarray.component_manager
+   :members:

docs/source/api/csp/subarray/index.rst

+=======================
+CSP subarray subpackage
+=======================
+
+.. automodule:: ska_tango_base.csp.subarray
+
+
+.. toctree::
+
+  CSP Subarray Component Manager<component_manager>
+  Reference CSP Subarray Component Manager<reference_component_manager>
+  CSP Subarray device<subarray_device>

docs/source/api/csp/subarray/reference_component_manager.rst

+========================================
+Reference CSP Subarray Component Manager
+========================================
+
+.. automodule:: ska_tango_base.csp.subarray.reference_component_manager
+   :members:

docs/source/api/csp/subarray/subarray_device.rst

+===================
+CSP Subarray device
+===================
+
+.. automodule:: ska_tango_base.csp.subarray.subarray_device
+   :members:

docs/source/api/faults.rst

+======
+Faults
+======
+
+.. automodule:: ska_tango_base.faults
+   :members:

docs/source/api/index.rst

+===
+API
+===
+
+.. toctree::
+  :caption: Subpackages
+  :maxdepth: 2
+
+  Base subpackage<base/index>
+  Obs subpackage<obs/index>
+  CSP subpackage<csp/index>
+  Subarray subpackage<subarray/index>
+
+
+.. toctree::
+  :caption: Other devices
+  :maxdepth: 2
+
+  Alarm Handler device<alarm_handler_device>
+  Capability device<capability_device>
+  Logger device<logger_device>
+  Master device<master_device>
+  Tel State device<tel_state_device>
+
+
+.. toctree::
+  :caption: Other modules
+  :maxdepth: 2
+
+  Commands<commands>
+  Control Model<control_model>
+  Faults<faults>
+  Release<release>
+  Utils<utils>

docs/source/api/logger_device.rst

+=============
+Logger Device
+=============
+
+.. automodule:: ska_tango_base.logger_device
+   :members:

docs/source/api/master_device.rst

+=============
+Master Device
+=============
+
+.. automodule:: ska_tango_base.master_device
+   :members:

docs/source/api/obs/index.rst

+==============
+Obs subpackage
+==============
+
+.. automodule:: ska_tango_base.obs
+
+
+.. toctree::
+
+  Obs State Model<obs_state_model>
+  Obs Device<obs_device>

docs/source/api/obs/obs_device.rst

+==========
+Obs Device
+==========
+
+.. automodule:: ska_tango_base.obs.obs_device
+   :members:

docs/source/api/obs/obs_state_model.rst

+===============
+Obs State Model
+===============
+
+.. automodule:: ska_tango_base.obs.obs_state_model
+   :members: