ska\_tmc\_cspsubarrayleafnode.delay_model package
=================================================

Submodules
----------

ska\_tmc\_cspsubarrayleafnode.delay\_model module
-------------------------------------------------

.. automodule:: ska_tmc_cspsubarrayleafnode.delay_model
   :members:
   :undoc-members:
   :show-inheritance:

ska\_tmc\_cspsubarrayleafnode.delay\_model\_mid module
------------------------------------------------------

.. automodule:: ska_tmc_cspsubarrayleafnode.delay_model_mid
   :members:
   :undoc-members:
   :show-inheritance:

ska\_tmc\_cspsubarrayleafnode.delay\_model\_low module
------------------------------------------------------
.. automodule:: ska_tmc_cspsubarrayleafnode.delay_model_low
   :members:
   :undoc-members:
   :show-inheritance:

ska\_tmc\_cspsubarrayleafnode.delay\_model\_pst\_beam module
-------------------------------------------------------------
.. warning::
   The PST delay model requires "field" key present under timing_beams section.
   
.. automodule:: ska_tmc_cspsubarrayleafnode.delay_model_pst_beam
   :members:
   :undoc-members:
   :show-inheritance:

ska\_tmc\_cspsubarrayleafnode.delay\_model\_pss\_beam module
-------------------------------------------------------------
   
.. automodule:: ska_tmc_cspsubarrayleafnode.delay_model_pss_beam
   :members:
   :undoc-members:
   :show-inheritance:


Weather Station Device
======================

The Weather Station is a device responsible for collecting key environmental parameters used by the Delay Manager to compute accurate delay values. These parameters include:

- **Temperature**
- **Humidity**
- **Pressure**

The device must be activated before it begins reporting data. This is achieved by setting its `adminMode` to `0`, which transitions it into the operational state.

Usage
-----

To enable the Weather Station device, execute the following instruction:

.. code-block:: python

    weather_Station_dev_proxy.adminMode = 0

Once enabled, the device begins transmitting environmental data at regular intervals. The Delay Manager utilizes this data to calculate corrections or compensations needed for signal timing and synchronization, which is critical in high-precision systems such as telescope arrays, scientific instrumentation, or time-sensitive communication networks.

Device Integration
------------------

The Weather Station integrates with other components in the system architecture, typically communicating with:

- Delay Manager service
- Central monitoring and control systems
- Logging and diagnostics modules

A consistent `10.00/10` Python linting score indicates that all related Python code associated with the device's configuration, data collection, and interface passes static analysis checks and adheres to code quality standards.


Command Timeout
===============

The ``CommandTimeout`` attribute is introduced to allow updating the timeout value
for commands without requiring a redeployment. This provides flexibility in tuning
the timeout dynamically at runtime based on operational needs.

The ``CommandTimeOutDefault`` property is also introduced, which can be used to set
a default timeout value during the deployment phase. This ensures that an initial
timeout value is preconfigured when the component starts for the first time.

Usage
-----

* **CommandTimeout attribute**  
  - Can be updated at runtime without redeployment.
  - Helps in adapting to varying command execution times.

* **CommandTimeOutDefault property**  
  - Configurable in the deployment configuration (e.g., ``values.yaml``).
  - Sets the initial timeout value at startup.