diff --git a/devices/HW_device_template.py b/devices/HW_device_template.py
index 3d8b19c20b37cdf9b5d1d5780d28edad0c333f0d..a16f11211f43f8aa49e4c9de47b1c48d1c280090 100644
--- a/devices/HW_device_template.py
+++ b/devices/HW_device_template.py
@@ -1,89 +1,89 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of the PCC project
-#
-#
-#
-# Distributed under the terms of the APACHE license.
-# See LICENSE.txt for more info.
-
-""" Hardware Device Server for LOFAR2.0
-
-"""
-
-# PyTango imports
-from tango.server import run
-# Additional import
-
-from src.hardware_device import *
-
-
-__all__ = ["HW_dev"]
-
-class HW_dev(hardware_device):
- """
- This class is the minimal (read empty) implementation of a class using 'hardware_device'
- """
-
- # ----------
- # Attributes
- # ----------
- """
- attribute wrapper objects can be declared here. All attribute wrapper objects will get automatically put in a ist (attr_list) for easy access
-
- example = attribute_wrapper(comms_annotation="this is an example", datatype=numpy.double, dims=(8, 2), access=AttrWriteType.READ_WRITE)
- ...
-
- """
-
- def always_executed_hook(self):
- """Method always executed before any TANGO command is executed."""
- pass
-
- def delete_device(self):
- """Hook to delete resources allocated in init_device.
-
- This method allows for any memory or other resources allocated in the
- init_device method to be released. This method is called by the device
- destructor and by the device Init command (a Tango built-in).
- """
- self.debug_stream("Shutting down...")
-
- self.Off()
- self.debug_stream("Shut down. Good bye.")
-
- # --------
- # overloaded functions
- # --------
- def fault(self):
- """ user code here. is called when the state is set to FAULT """
- pass
-
- def off(self):
- """ user code here. is called when the state is set to OFF """
- pass
-
- def on(self):
- """ user code here. is called when the state is set to ON """
-
- pass
-
- def standby(self):
- """ user code here. is called when the state is set to STANDBY """
- pass
-
- def initialise(self):
- """ user code here. is called when the sate is set to INIT """
- pass
-
-# ----------
-# Run server
-# ----------
-def main(args=None, **kwargs):
- """Main function of the hardware device module."""
- return run((HW_dev,), args=args, **kwargs)
-
-
-if __name__ == '__main__':
- main()
-
+# -*- coding: utf-8 -*-
+#
+# This file is part of the PCC project
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+""" Hardware Device Server for LOFAR2.0
+
+"""
+
+# PyTango imports
+from tango.server import run
+# Additional import
+
+from src.hardware_device import *
+
+
+__all__ = ["HW_dev"]
+
+class HW_dev(hardware_device):
+ """
+ This class is the minimal (read empty) implementation of a class using 'hardware_device'
+ """
+
+ # ----------
+ # Attributes
+ # ----------
+ """
+ attribute wrapper objects can be declared here. All attribute wrapper objects will get automatically put in a ist (attr_list) for easy access
+
+ example = attribute_wrapper(comms_annotation="this is an example", datatype=numpy.double, dims=(8, 2), access=AttrWriteType.READ_WRITE)
+ ...
+
+ """
+
+ def always_executed_hook(self):
+ """Method always executed before any TANGO command is executed."""
+ pass
+
+ def delete_device(self):
+ """Hook to delete resources allocated in init_device.
+
+ This method allows for any memory or other resources allocated in the
+ init_device method to be released. This method is called by the device
+ destructor and by the device Init command (a Tango built-in).
+ """
+ self.debug_stream("Shutting down...")
+
+ self.Off()
+ self.debug_stream("Shut down. Good bye.")
+
+ # --------
+ # overloaded functions
+ # --------
+ def fault(self):
+ """ user code here. is called when the state is set to FAULT """
+ pass
+
+ def off(self):
+ """ user code here. is called when the state is set to OFF """
+ pass
+
+ def on(self):
+ """ user code here. is called when the state is set to ON """
+
+ pass
+
+ def standby(self):
+ """ user code here. is called when the state is set to STANDBY """
+ pass
+
+ def initialise(self):
+ """ user code here. is called when the sate is set to INIT """
+ pass
+
+# ----------
+# Run server
+# ----------
+def main(args=None, **kwargs):
+ """Main function of the hardware device module."""
+ return run((HW_dev,), args=args, **kwargs)
+
+
+if __name__ == '__main__':
+ main()
+
diff --git a/devices/LICENSE.txt b/devices/LICENSE.txt
index 8a0eaeb196094a651006f51fd99c0c05cb16ccd6..c9978b8eee263aebfdd8d0a016e447940682ba8b 100644
--- a/devices/LICENSE.txt
+++ b/devices/LICENSE.txt
@@ -1,201 +1,201 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
-Copyright 2021 ASTRON Netherlands Institute for Radio Astronomy
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright 2021 ASTRON Netherlands Institute for Radio Astronomy
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/devices/PCC.py b/devices/PCC.py
index fdb30ed39db4df9f18a21bfd2089e345127090c9..84773c9ae8b030390461e6ce233c5e0b18b0f693 100644
--- a/devices/PCC.py
+++ b/devices/PCC.py
@@ -1,247 +1,247 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of the PCC project
-#
-#
-#
-# Distributed under the terms of the APACHE license.
-# See LICENSE.txt for more info.
-
-""" PCC Device Server for LOFAR2.0
-
-"""
-
-# PyTango imports
-from tango import DebugIt
-from tango.server import run, command
-from tango.server import device_property
-
-# Additional import
-from clients.opcua_connection import OPCUAConnection
-from src.attribute_wrapper import *
-from src.hardware_device import *
-from src.lofar_logging import device_logging_to_python
-
-
-__all__ = ["PCC", "main"]
-
-@device_logging_to_python({"device": "PCC"})
-class PCC(hardware_device):
- # -----------------
- # Device Properties
- # -----------------
- OPC_Server_Name = device_property(
- dtype='DevString',
- mandatory=True
- )
-
- OPC_Server_Port = device_property(
- dtype='DevULong',
- mandatory=True
- )
-
- OPC_Time_Out = device_property(
- dtype='DevDouble',
- mandatory=True
- )
-
- OPC_Namespace = device_property(
- dtype='DevString',
- mandatory=False
- )
-
- # ----------
- # Attributes
- # ----------
- RCU_state_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_state_R"], datatype=numpy.str_, access=AttrWriteType.READ_WRITE)
-
- RCU_mask_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_mask_RW"], datatype=numpy.bool_, dims=(32,), access=AttrWriteType.READ_WRITE)
-
- Ant_mask_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:Ant_mask_RW"], datatype=numpy.bool_, dims=(3, 32), access=AttrWriteType.READ_WRITE)
-
- RCU_attenuator_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_attenuator_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_attenuator_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_attenuator_RW"], datatype=numpy.int64, dims=(3, 32), access=AttrWriteType.READ_WRITE)
-
- RCU_band_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_band_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_band_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_band_RW"], datatype=numpy.int64, dims=(3, 32), access=AttrWriteType.READ_WRITE)
-
- RCU_temperature_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_temperature_R"], datatype=numpy.float64, dims=(32,))
-
- RCU_Pwr_dig_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_Pwr_dig_R"], datatype=numpy.int64, dims=(32,))
-
- RCU_LED0_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_LED0_R"], datatype=numpy.int64, dims=(32,))
-
- RCU_LED0_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_LED0_RW"], datatype=numpy.int64, dims=(32,), access=AttrWriteType.READ_WRITE)
-
- RCU_ADC_lock_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_lock_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_ADC_SYNC_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_SYNC_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_ADC_JESD_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_JESD_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_ADC_CML_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_CML_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_OUT1_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_OUT1_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_OUT2_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_OUT2_R"], datatype=numpy.int64, dims=(3, 32))
-
- RCU_ID_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ID_R"], datatype=numpy.int64, dims=(32,))
-
- RCU_version_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_version_R"], datatype=numpy.str_, dims=(32,))
-
- HBA_element_beamformer_delays_R = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_beamformer_delays_R"], datatype=numpy.int64, dims=(32, 96))
-
- HBA_element_beamformer_delays_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_beamformer_delays_RW"], datatype=numpy.int64, dims=(32, 96), access=AttrWriteType.READ_WRITE)
-
- HBA_element_pwr_R = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_pwr_R"], datatype=numpy.int64, dims=(32, 96))
-
- HBA_element_pwr_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_pwr_RW"], datatype=numpy.int64, dims=(32, 96), access=AttrWriteType.READ_WRITE)
-
- uC_ID_R = attribute_wrapper(comms_annotation=["2:PCC", "2:uC_ID_R"], datatype=numpy.int64, dims=(32,))
-
- RCU_monitor_rate_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_monitor_rate_RW"], datatype=numpy.float64, access=AttrWriteType.READ_WRITE)
-
-
- def delete_device(self):
- """Hook to delete resources allocated in init_device.
-
- This method allows for any memory or other resources allocated in the
- init_device method to be released. This method is called by the device
- destructor and by the device Init command (a Tango built-in).
- """
- self.debug_stream("Shutting down...")
- self.Off()
- self.debug_stream("Shut down. Good bye.")
-
- # --------
- # overloaded functions
- # --------
- def off(self):
- """ user code here. is called when the state is set to OFF """
-
- # Stop keep-alive
- self.OPCua_client.disconnect()
-
- def initialise(self):
- """ user code here. is called when the state is set to INIT """
-
- #set up the OPC ua client
- namespace = "http://lofar.eu"
- if self.OPC_Namespace is not None:
- namespace = self.OPC_Namespace
-
- self.OPCua_client = OPCUAConnection("opc.tcp://{}:{}/".format(self.OPC_Server_Name, self.OPC_Server_Port), namespace, self.OPC_Time_Out, self.Standby, self.Fault, self)
-
- # map the attributes to the OPC ua comm client
- for i in self.attr_list():
- try:
- i.set_comm_client(self.OPCua_client)
- except:
- pass
-
- # Init the dict that contains function to OPC-UA function mappings.
- self.function_mapping = {}
- self.function_mapping["RCU_off"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_off"])
- self.function_mapping["RCU_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_on"])
- self.function_mapping["ADC_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:ADC_on"])
- self.function_mapping["RCU_update"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_update"])
- self.function_mapping["CLK_off"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_off"])
- self.function_mapping["CLK_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_on"])
- self.function_mapping["CLK_PLL_setup"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_PLL_setup"])
-
- self.OPCua_client.start()
-
- # --------
- # Commands
- # --------
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def RCU_off(self):
- """
-
- :return:None
- """
- self.function_mapping["RCU_off"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def RCU_on(self):
- """
-
- :return:None
- """
- self.function_mapping["RCU_on"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def ADC_on(self):
- """
-
- :return:None
- """
- self.function_mapping["ADC_on"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def RCU_update(self):
- """
-
- :return:None
- """
- self.function_mapping["RCU_update"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def CLK_off(self):
- """
-
- :return:None
- """
- self.function_mapping["CLK_off"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def CLK_on(self):
- """
-
- :return:None
- """
- self.function_mapping["CLK_on"]()
-
- @command()
- @DebugIt()
- @only_when_on
- @fault_on_error
- def CLK_PLL_setup(self):
- """
-
- :return:None
- """
- self.function_mapping["CLK_PLL_setup"]()
-
-
-# ----------
-# Run server
-# ----------
-def main(args=None, **kwargs):
- """Main function of the PCC module."""
- return run((PCC,), args=args, **kwargs)
-
-
-if __name__ == '__main__':
- main()
-
+# -*- coding: utf-8 -*-
+#
+# This file is part of the PCC project
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+""" PCC Device Server for LOFAR2.0
+
+"""
+
+# PyTango imports
+from tango import DebugIt
+from tango.server import run, command
+from tango.server import device_property
+
+# Additional import
+from clients.opcua_connection import OPCUAConnection
+from src.attribute_wrapper import *
+from src.hardware_device import *
+from src.lofar_logging import device_logging_to_python
+
+
+__all__ = ["PCC", "main"]
+
+@device_logging_to_python({"device": "PCC"})
+class PCC(hardware_device):
+ # -----------------
+ # Device Properties
+ # -----------------
+ OPC_Server_Name = device_property(
+ dtype='DevString',
+ mandatory=True
+ )
+
+ OPC_Server_Port = device_property(
+ dtype='DevULong',
+ mandatory=True
+ )
+
+ OPC_Time_Out = device_property(
+ dtype='DevDouble',
+ mandatory=True
+ )
+
+ OPC_Namespace = device_property(
+ dtype='DevString',
+ mandatory=False
+ )
+
+ # ----------
+ # Attributes
+ # ----------
+ RCU_state_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_state_R"], datatype=numpy.str_, access=AttrWriteType.READ_WRITE)
+
+ RCU_mask_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_mask_RW"], datatype=numpy.bool_, dims=(32,), access=AttrWriteType.READ_WRITE)
+
+ Ant_mask_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:Ant_mask_RW"], datatype=numpy.bool_, dims=(3, 32), access=AttrWriteType.READ_WRITE)
+
+ RCU_attenuator_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_attenuator_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_attenuator_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_attenuator_RW"], datatype=numpy.int64, dims=(3, 32), access=AttrWriteType.READ_WRITE)
+
+ RCU_band_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_band_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_band_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_band_RW"], datatype=numpy.int64, dims=(3, 32), access=AttrWriteType.READ_WRITE)
+
+ RCU_temperature_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_temperature_R"], datatype=numpy.float64, dims=(32,))
+
+ RCU_Pwr_dig_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_Pwr_dig_R"], datatype=numpy.int64, dims=(32,))
+
+ RCU_LED0_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_LED0_R"], datatype=numpy.int64, dims=(32,))
+
+ RCU_LED0_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_LED0_RW"], datatype=numpy.int64, dims=(32,), access=AttrWriteType.READ_WRITE)
+
+ RCU_ADC_lock_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_lock_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_ADC_SYNC_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_SYNC_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_ADC_JESD_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_JESD_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_ADC_CML_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ADC_CML_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_OUT1_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_OUT1_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_OUT2_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_OUT2_R"], datatype=numpy.int64, dims=(3, 32))
+
+ RCU_ID_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_ID_R"], datatype=numpy.int64, dims=(32,))
+
+ RCU_version_R = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_version_R"], datatype=numpy.str_, dims=(32,))
+
+ HBA_element_beamformer_delays_R = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_beamformer_delays_R"], datatype=numpy.int64, dims=(32, 96))
+
+ HBA_element_beamformer_delays_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_beamformer_delays_RW"], datatype=numpy.int64, dims=(32, 96), access=AttrWriteType.READ_WRITE)
+
+ HBA_element_pwr_R = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_pwr_R"], datatype=numpy.int64, dims=(32, 96))
+
+ HBA_element_pwr_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:HBA_element_pwr_RW"], datatype=numpy.int64, dims=(32, 96), access=AttrWriteType.READ_WRITE)
+
+ uC_ID_R = attribute_wrapper(comms_annotation=["2:PCC", "2:uC_ID_R"], datatype=numpy.int64, dims=(32,))
+
+ RCU_monitor_rate_RW = attribute_wrapper(comms_annotation=["2:PCC", "2:RCU_monitor_rate_RW"], datatype=numpy.float64, access=AttrWriteType.READ_WRITE)
+
+
+ def delete_device(self):
+ """Hook to delete resources allocated in init_device.
+
+ This method allows for any memory or other resources allocated in the
+ init_device method to be released. This method is called by the device
+ destructor and by the device Init command (a Tango built-in).
+ """
+ self.debug_stream("Shutting down...")
+ self.Off()
+ self.debug_stream("Shut down. Good bye.")
+
+ # --------
+ # overloaded functions
+ # --------
+ def off(self):
+ """ user code here. is called when the state is set to OFF """
+
+ # Stop keep-alive
+ self.OPCua_client.disconnect()
+
+ def initialise(self):
+ """ user code here. is called when the state is set to INIT """
+
+ #set up the OPC ua client
+ namespace = "http://lofar.eu"
+ if self.OPC_Namespace is not None:
+ namespace = self.OPC_Namespace
+
+ self.OPCua_client = OPCUAConnection("opc.tcp://{}:{}/".format(self.OPC_Server_Name, self.OPC_Server_Port), namespace, self.OPC_Time_Out, self.Standby, self.Fault, self)
+
+ # map the attributes to the OPC ua comm client
+ for i in self.attr_list():
+ try:
+ i.set_comm_client(self.OPCua_client)
+ except:
+ pass
+
+ # Init the dict that contains function to OPC-UA function mappings.
+ self.function_mapping = {}
+ self.function_mapping["RCU_off"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_off"])
+ self.function_mapping["RCU_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_on"])
+ self.function_mapping["ADC_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:ADC_on"])
+ self.function_mapping["RCU_update"] = self.OPCua_client._setup_annotation(["2:PCC", "2:RCU_update"])
+ self.function_mapping["CLK_off"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_off"])
+ self.function_mapping["CLK_on"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_on"])
+ self.function_mapping["CLK_PLL_setup"] = self.OPCua_client._setup_annotation(["2:PCC", "2:CLK_PLL_setup"])
+
+ self.OPCua_client.start()
+
+ # --------
+ # Commands
+ # --------
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def RCU_off(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["RCU_off"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def RCU_on(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["RCU_on"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def ADC_on(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["ADC_on"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def RCU_update(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["RCU_update"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def CLK_off(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["CLK_off"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def CLK_on(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["CLK_on"]()
+
+ @command()
+ @DebugIt()
+ @only_when_on
+ @fault_on_error
+ def CLK_PLL_setup(self):
+ """
+
+ :return:None
+ """
+ self.function_mapping["CLK_PLL_setup"]()
+
+
+# ----------
+# Run server
+# ----------
+def main(args=None, **kwargs):
+ """Main function of the PCC module."""
+ return run((PCC,), args=args, **kwargs)
+
+
+if __name__ == '__main__':
+ main()
+
diff --git a/devices/README.md b/devices/README.md
index 99772cd2e7e076a62201d4b47e525f4bf4617582..1d962a271e60cc125feb88d5b1ce1b7c5f3d627b 100644
--- a/devices/README.md
+++ b/devices/README.md
@@ -1,26 +1,26 @@
-# Device wrapper
-
-This code provides an attribute_wrapper class in place of attributes for tango devices. the attribute wrappers contain additional code
-that moves a lot of the complexity and redundant code to the background.
-
-The tango Device class is also abstracted further to a "hardware_device" class. This class wraps
-
-The only things required on the users part are to declare the attributes using the attribute_wrapper (see `example/example_device`),
-declare what client the attribute has to use in the initialisation and provide support for the used clients.
-To see how to add support for new clients, see `clients/README.md`
-
-In addition it also provides an abstraction to the tango device, specifically for hardware devices. Examples of hardware devices
-can be found in TODO and an empty template can be found in `HW_device_template.py`
-
-Requires numpy
-```pip install numpy```
-
-Requires opcua
-```pip install opcua```
-
-Requires pytango
-```pip install pytango```
-
-### usage
-You can start the device by calling it in any console with:
-<Device_name>.py instance_name
+# Device wrapper
+
+This code provides an attribute_wrapper class in place of attributes for tango devices. the attribute wrappers contain additional code
+that moves a lot of the complexity and redundant code to the background.
+
+The tango Device class is also abstracted further to a "hardware_device" class. This class wraps
+
+The only things required on the users part are to declare the attributes using the attribute_wrapper (see `example/example_device`),
+declare what client the attribute has to use in the initialisation and provide support for the used clients.
+To see how to add support for new clients, see `clients/README.md`
+
+In addition it also provides an abstraction to the tango device, specifically for hardware devices. Examples of hardware devices
+can be found in TODO and an empty template can be found in `HW_device_template.py`
+
+Requires numpy
+```pip install numpy```
+
+Requires opcua
+```pip install opcua```
+
+Requires pytango
+```pip install pytango```
+
+### usage
+You can start the device by calling it in any console with:
+<Device_name>.py instance_name
diff --git a/devices/SDP.py b/devices/SDP.py
index ec53be8a722e7f355f18b8655cb74b05fa5033cc..f2e87890c112bcb3027747f7ec2fd464282b7faa 100644
--- a/devices/SDP.py
+++ b/devices/SDP.py
@@ -1,133 +1,133 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of the SDP project
-#
-#
-#
-# Distributed under the terms of the APACHE license.
-# See LICENSE.txt for more info.
-
-""" SDP Device Server for LOFAR2.0
-
-"""
-
-# PyTango imports
-from tango.server import run
-from tango.server import device_property
-# Additional import
-
-from clients.opcua_connection import OPCUAConnection
-from src.attribute_wrapper import *
-from src.hardware_device import *
-from src.lofar_logging import device_logging_to_python
-
-
-__all__ = ["SDP", "main"]
-
-@device_logging_to_python({"device": "SDP"})
-class SDP(hardware_device):
- """
-
- **Properties:**
-
- - Device Property
- OPC_Server_Name
- - Type:'DevString'
- OPC_Server_Port
- - Type:'DevULong'
- OPC_Time_Out
- - Type:'DevDouble'
- """
-
- # -----------------
- # Device Properties
- # -----------------
-
- OPC_Server_Name = device_property(
- dtype='DevString',
- mandatory=True
- )
-
- OPC_Server_Port = device_property(
- dtype='DevULong',
- mandatory=True
- )
-
- OPC_Time_Out = device_property(
- dtype='DevDouble',
- mandatory=True
- )
-
- # ----------
- # Attributes
- # ----------
- fpga_mask_RW = attribute_wrapper(comms_annotation=["1:fpga_mask_RW"], datatype=numpy.bool_, dims=(16,), access=AttrWriteType.READ_WRITE)
- fpga_scrap_R = attribute_wrapper(comms_annotation=["1:fpga_scrap_R"], datatype=numpy.int32, dims=(2048,))
- fpga_scrap_RW = attribute_wrapper(comms_annotation=["1:fpga_scrap_RW"], datatype=numpy.int32, dims=(2048,), access=AttrWriteType.READ_WRITE)
- fpga_status_R = attribute_wrapper(comms_annotation=["1:fpga_status_R"], datatype=numpy.bool_, dims=(16,))
- fpga_temp_R = attribute_wrapper(comms_annotation=["1:fpga_temp_R"], datatype=numpy.float_, dims=(16,))
- fpga_version_R = attribute_wrapper(comms_annotation=["1:fpga_version_R"], datatype=numpy.str_, dims=(16,))
- fpga_weights_R = attribute_wrapper(comms_annotation=["1:fpga_weights_R"], datatype=numpy.int16, dims=(16, 12 * 488 * 2))
- fpga_weights_RW = attribute_wrapper(comms_annotation=["1:fpga_weights_RW"], datatype=numpy.int16, dims=(16, 12 * 488 * 2), access=AttrWriteType.READ_WRITE)
- tr_busy_R = attribute_wrapper(comms_annotation=["1:tr_busy_R"], datatype=numpy.bool_)
- # NOTE: typo in node name is 'tr_reload_W' should be 'tr_reload_RW'
- tr_reload_RW = attribute_wrapper(comms_annotation=["1:tr_reload_W"], datatype=numpy.bool_, access=AttrWriteType.READ_WRITE)
- tr_tod_R = attribute_wrapper(comms_annotation=["1:tr_tod_R"], datatype=numpy.uint64)
- tr_uptime_R = attribute_wrapper(comms_annotation=["1:tr_uptime_R"], datatype=numpy.uint64)
-
- def always_executed_hook(self):
- """Method always executed before any TANGO command is executed."""
- pass
-
- def delete_device(self):
- """Hook to delete resources allocated in init_device.
-
- This method allows for any memory or other resources allocated in the
- init_device method to be released. This method is called by the device
- destructor and by the device Init command (a Tango built-in).
- """
- self.debug_stream("Shutting down...")
-
- self.Off()
- self.debug_stream("Shut down. Good bye.")
-
- # --------
- # overloaded functions
- # --------
- def off(self):
- """ user code here. is called when the state is set to OFF """
-
- # Stop keep-alive
- self.opcua_connection.stop()
-
- def initialise(self):
- """ user code here. is called when the sate is set to INIT """
- """Initialises the attributes and properties of the PCC."""
-
- # set up the OPC ua client
- self.OPCua_client = OPCUAConnection("opc.tcp://{}:{}/".format(self.OPC_Server_Name, self.OPC_Server_Port), "http://lofar.eu", self.OPC_Time_Out, self.Standby, self.Fault, self)
-
- # will contain all the values for this object
- self.setup_value_dict()
-
- # map an access helper class
- for i in self.attr_list():
- i.set_comm_client(self.OPCua_client)
-
- self.OPCua_client.start()
-
- # --------
- # Commands
- # --------
-
-# ----------
-# Run server
-# ----------
-def main(args=None, **kwargs):
- """Main function of the SDP module."""
- return run((SDP,), args=args, **kwargs)
-
-
-if __name__ == '__main__':
- main()
-
+# -*- coding: utf-8 -*-
+#
+# This file is part of the SDP project
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+""" SDP Device Server for LOFAR2.0
+
+"""
+
+# PyTango imports
+from tango.server import run
+from tango.server import device_property
+# Additional import
+
+from clients.opcua_connection import OPCUAConnection
+from src.attribute_wrapper import *
+from src.hardware_device import *
+from src.lofar_logging import device_logging_to_python
+
+
+__all__ = ["SDP", "main"]
+
+@device_logging_to_python({"device": "SDP"})
+class SDP(hardware_device):
+ """
+
+ **Properties:**
+
+ - Device Property
+ OPC_Server_Name
+ - Type:'DevString'
+ OPC_Server_Port
+ - Type:'DevULong'
+ OPC_Time_Out
+ - Type:'DevDouble'
+ """
+
+ # -----------------
+ # Device Properties
+ # -----------------
+
+ OPC_Server_Name = device_property(
+ dtype='DevString',
+ mandatory=True
+ )
+
+ OPC_Server_Port = device_property(
+ dtype='DevULong',
+ mandatory=True
+ )
+
+ OPC_Time_Out = device_property(
+ dtype='DevDouble',
+ mandatory=True
+ )
+
+ # ----------
+ # Attributes
+ # ----------
+ fpga_mask_RW = attribute_wrapper(comms_annotation=["1:fpga_mask_RW"], datatype=numpy.bool_, dims=(16,), access=AttrWriteType.READ_WRITE)
+ fpga_scrap_R = attribute_wrapper(comms_annotation=["1:fpga_scrap_R"], datatype=numpy.int32, dims=(2048,))
+ fpga_scrap_RW = attribute_wrapper(comms_annotation=["1:fpga_scrap_RW"], datatype=numpy.int32, dims=(2048,), access=AttrWriteType.READ_WRITE)
+ fpga_status_R = attribute_wrapper(comms_annotation=["1:fpga_status_R"], datatype=numpy.bool_, dims=(16,))
+ fpga_temp_R = attribute_wrapper(comms_annotation=["1:fpga_temp_R"], datatype=numpy.float_, dims=(16,))
+ fpga_version_R = attribute_wrapper(comms_annotation=["1:fpga_version_R"], datatype=numpy.str_, dims=(16,))
+ fpga_weights_R = attribute_wrapper(comms_annotation=["1:fpga_weights_R"], datatype=numpy.int16, dims=(16, 12 * 488 * 2))
+ fpga_weights_RW = attribute_wrapper(comms_annotation=["1:fpga_weights_RW"], datatype=numpy.int16, dims=(16, 12 * 488 * 2), access=AttrWriteType.READ_WRITE)
+ tr_busy_R = attribute_wrapper(comms_annotation=["1:tr_busy_R"], datatype=numpy.bool_)
+ # NOTE: typo in node name is 'tr_reload_W' should be 'tr_reload_RW'
+ tr_reload_RW = attribute_wrapper(comms_annotation=["1:tr_reload_W"], datatype=numpy.bool_, access=AttrWriteType.READ_WRITE)
+ tr_tod_R = attribute_wrapper(comms_annotation=["1:tr_tod_R"], datatype=numpy.uint64)
+ tr_uptime_R = attribute_wrapper(comms_annotation=["1:tr_uptime_R"], datatype=numpy.uint64)
+
+ def always_executed_hook(self):
+ """Method always executed before any TANGO command is executed."""
+ pass
+
+ def delete_device(self):
+ """Hook to delete resources allocated in init_device.
+
+ This method allows for any memory or other resources allocated in the
+ init_device method to be released. This method is called by the device
+ destructor and by the device Init command (a Tango built-in).
+ """
+ self.debug_stream("Shutting down...")
+
+ self.Off()
+ self.debug_stream("Shut down. Good bye.")
+
+ # --------
+ # overloaded functions
+ # --------
+ def off(self):
+ """ user code here. is called when the state is set to OFF """
+
+ # Stop keep-alive
+ self.opcua_connection.stop()
+
+ def initialise(self):
+ """ user code here. is called when the sate is set to INIT """
+ """Initialises the attributes and properties of the PCC."""
+
+ # set up the OPC ua client
+ self.OPCua_client = OPCUAConnection("opc.tcp://{}:{}/".format(self.OPC_Server_Name, self.OPC_Server_Port), "http://lofar.eu", self.OPC_Time_Out, self.Standby, self.Fault, self)
+
+ # will contain all the values for this object
+ self.setup_value_dict()
+
+ # map an access helper class
+ for i in self.attr_list():
+ i.set_comm_client(self.OPCua_client)
+
+ self.OPCua_client.start()
+
+ # --------
+ # Commands
+ # --------
+
+# ----------
+# Run server
+# ----------
+def main(args=None, **kwargs):
+ """Main function of the SDP module."""
+ return run((SDP,), args=args, **kwargs)
+
+
+if __name__ == '__main__':
+ main()
+
diff --git a/devices/clients/README.md b/devices/clients/README.md
index 34d2709a0c70ab960b4ac23cb19668fab689bc7c..3613344461e8abb64e5a68a1d30c68b3927d22b4 100644
--- a/devices/clients/README.md
+++ b/devices/clients/README.md
@@ -1,4 +1,4 @@
-this folder contains all the comms_client implementations for organisation
-
-### How to add a new client
+this folder contains all the comms_client implementations for organisation
+
+### How to add a new client
soon™
\ No newline at end of file
diff --git a/devices/clients/test_client.py b/devices/clients/test_client.py
index 6bac45275275a86156a518286e353e7f844f9f02..d3e63930a0354ed0e061d9ee54d6f8a9e661fda8 100644
--- a/devices/clients/test_client.py
+++ b/devices/clients/test_client.py
@@ -1,106 +1,106 @@
-from src.comms_client import *
-
-# <class 'numpy.bool_'>
-
-class example_client(CommClient):
- """
- this class provides an example implementation of a comms_client.
- Durirng initialisation it creates a correctly shaped zero filled value. on read that value is returned and on write its modified.
- """
-
- def start(self):
- super().start()
-
- def __init__(self, standby_func, fault_func, streams, try_interval=2):
- """
- initialises the class and tries to connect to the client.
- """
- super().__init__(standby_func, fault_func, streams, try_interval)
-
- # Explicitly connect
- if not self.connect():
- # hardware or infra is down -- needs fixing first
- fault_func()
- return
-
- def connect(self):
- """
- this function provides a location for the code neccecary to connect to the client
- """
-
- self.streams.debug_stream("the example client doesn't actually connect to anything silly")
-
- self.connected = True # set connected to true
- return True # if succesfull, return true. otherwise return false
-
- def disconnect(self):
- self.connected = False # always force a reconnect, regardless of a successful disconnect
- self.streams.debug_stream("disconnected from the 'client' ")
-
- def _setup_annotation(self, annotation):
- """
- this function gives the client access to the comm client annotation data given to the attribute wrapper.
- The annotation data can be used to provide whatever extra data is necessary in order to find/access the monitor/control point.
-
- the annotation can be in whatever format may be required. it is up to the user to handle its content
- example annotation may include:
- - a file path and file line/location
- - COM object path
- """
-
- # as this is an example, just print the annotation
- self.streams.debug_stream("annotation: {}".format(annotation))
-
- def _setup_value_conversion(self, attribute):
- """
- gives the client access to the attribute_wrapper object in order to access all
- necessary data such as dimensionality and data type
- """
-
- if attribute.dim_y > 1:
- dims = (attribute.dim_y, attribute.dim_x)
- else:
- dims = (attribute.dim_x,)
-
- dtype = attribute.numpy_type
-
- return dims, dtype
-
-
- def _setup_mapping(self, dims, dtype):
- """
- takes all gathered data to configure and return the correct read and write functions
- """
-
- value = numpy.zeros(dims, dtype)
-
- def read_function():
- self.streams.debug_stream("from read_function, reading {} array of type {}".format(dims, dtype))
- return value
-
- def write_function(write_value):
- self.streams.debug_stream("from write_function, writing {} array of type {}".format(dims, dtype))
- value = write_value
-
- self.streams.debug_stream("created and bound example_client read/write functions to attribute_wrapper object")
- return read_function, write_function
-
-
- def setup_attribute(self, annotation=None, attribute=None):
- """
- MANDATORY function: is used by the attribute wrapper to get read/write functions.
- must return the read and write functions
- """
-
- # process the comms_annotation
- self._setup_annotation(annotation)
-
- # get all the necessary data to set up the read/write functions from the attribute_wrapper
- dims, dtype = self._setup_value_conversion(attribute)
-
- # configure and return the read/write functions
- read_function, write_function = self._setup_mapping(dims, dtype)
-
- # return the read/write functions
- return read_function, write_function
-
+from src.comms_client import *
+
+# <class 'numpy.bool_'>
+
+class example_client(CommClient):
+ """
+ this class provides an example implementation of a comms_client.
+ Durirng initialisation it creates a correctly shaped zero filled value. on read that value is returned and on write its modified.
+ """
+
+ def start(self):
+ super().start()
+
+ def __init__(self, standby_func, fault_func, streams, try_interval=2):
+ """
+ initialises the class and tries to connect to the client.
+ """
+ super().__init__(standby_func, fault_func, streams, try_interval)
+
+ # Explicitly connect
+ if not self.connect():
+ # hardware or infra is down -- needs fixing first
+ fault_func()
+ return
+
+ def connect(self):
+ """
+ this function provides a location for the code neccecary to connect to the client
+ """
+
+ self.streams.debug_stream("the example client doesn't actually connect to anything silly")
+
+ self.connected = True # set connected to true
+ return True # if succesfull, return true. otherwise return false
+
+ def disconnect(self):
+ self.connected = False # always force a reconnect, regardless of a successful disconnect
+ self.streams.debug_stream("disconnected from the 'client' ")
+
+ def _setup_annotation(self, annotation):
+ """
+ this function gives the client access to the comm client annotation data given to the attribute wrapper.
+ The annotation data can be used to provide whatever extra data is necessary in order to find/access the monitor/control point.
+
+ the annotation can be in whatever format may be required. it is up to the user to handle its content
+ example annotation may include:
+ - a file path and file line/location
+ - COM object path
+ """
+
+ # as this is an example, just print the annotation
+ self.streams.debug_stream("annotation: {}".format(annotation))
+
+ def _setup_value_conversion(self, attribute):
+ """
+ gives the client access to the attribute_wrapper object in order to access all
+ necessary data such as dimensionality and data type
+ """
+
+ if attribute.dim_y > 1:
+ dims = (attribute.dim_y, attribute.dim_x)
+ else:
+ dims = (attribute.dim_x,)
+
+ dtype = attribute.numpy_type
+
+ return dims, dtype
+
+
+ def _setup_mapping(self, dims, dtype):
+ """
+ takes all gathered data to configure and return the correct read and write functions
+ """
+
+ value = numpy.zeros(dims, dtype)
+
+ def read_function():
+ self.streams.debug_stream("from read_function, reading {} array of type {}".format(dims, dtype))
+ return value
+
+ def write_function(write_value):
+ self.streams.debug_stream("from write_function, writing {} array of type {}".format(dims, dtype))
+ value = write_value
+
+ self.streams.debug_stream("created and bound example_client read/write functions to attribute_wrapper object")
+ return read_function, write_function
+
+
+ def setup_attribute(self, annotation=None, attribute=None):
+ """
+ MANDATORY function: is used by the attribute wrapper to get read/write functions.
+ must return the read and write functions
+ """
+
+ # process the comms_annotation
+ self._setup_annotation(annotation)
+
+ # get all the necessary data to set up the read/write functions from the attribute_wrapper
+ dims, dtype = self._setup_value_conversion(attribute)
+
+ # configure and return the read/write functions
+ read_function, write_function = self._setup_mapping(dims, dtype)
+
+ # return the read/write functions
+ return read_function, write_function
+
diff --git a/devices/src/attribute_wrapper.py b/devices/src/attribute_wrapper.py
index c1b185038853b9b833e35dd3487ae6ad7c4b461a..bb5a3475159e633d8904c3060759739cee538293 100644
--- a/devices/src/attribute_wrapper.py
+++ b/devices/src/attribute_wrapper.py
@@ -1,141 +1,141 @@
-from tango.server import attribute
-from tango import AttrWriteType
-
-import numpy
-
-from src.wrappers import only_when_on, fault_on_error
-import logging
-logger = logging.getLogger()
-
-
-class attribute_wrapper(attribute):
- """
- Wraps all the attributes in a wrapper class to manage most of the redundant code behind the scenes
- """
-
- def __init__(self, comms_annotation=None, datatype=None, dims=(1,), access=AttrWriteType.READ, init_value=None, **kwargs):
- """
- wraps around the tango Attribute class. Provides an easier interface for 1d or 2d arrays. Also provides a way to abstract
- managing the communications interface.
- """
-
- # ensure the type is a numpy array
- if "numpy" not in str(datatype) and type(datatype) != str:
- raise TypeError("Attribute needs to be a Tango-supported numpy or str type, but has type \"%s\"" % (datatype,))
-
-
-
- self.comms_annotation = comms_annotation # store data that can be used by the comms interface. not used by the wrapper itself
- self.numpy_type = datatype # tango changes our attribute to their representation (E.g numpy.int64 becomes "DevLong64")
-
- self.init_value = init_value
- max_dim_y = 0
-
- # tango doesn't recognise numpy.str_, for consistencies sake we convert it here and hide this from the top level
- # NOTE: discuss, idk if this is an important detail somewhere else
- if datatype is numpy.str_:
- datatype = str
-
- # check if not scalar
- if isinstance(dims, tuple):
-
- # get first dimension
- max_dim_x = dims[0]
-
- # single dimension/spectrum requires the datatype to be wrapped in a tuple
- datatype = (datatype,)
-
- if len(dims) == 2:
- # get second dimension
- max_dim_y = dims[1]
- # wrap the datatype tuple in another tuple for 2d arrays/images
- datatype = (datatype,)
- else:
- # scalar, just set the single dimension
- max_dim_x = 1
-
-
- if access == AttrWriteType.READ_WRITE:
- """ if the attribute is of READ_WRITE type, assign the RW and write function to it"""
-
- @only_when_on
- @fault_on_error
- def read_RW(device):
- # print("read_RW {}, {}x{}, {}, {}".format(me.name, me.dim_x, me.dim_y, me.attr_type, me.value))
- """
- read_RW returns the value that was last written to the attribute
- """
- try:
- return device.value_dict[self]
- except Exception as e:
- raise Exception("Attribute read_RW function error, attempted to read value_dict with key: `%s`, are you sure this exists?", self) from e
-
-
- @only_when_on
- @fault_on_error
- def write_RW(device, value):
- """
- _write_RW writes a value to this attribute
- """
- self.write_function(value)
- device.value_dict[self] = value
-
- self.fget = read_RW
- self.fset = write_RW
-
-
- else:
- """ if the attribute is of READ type, assign the read function to it"""
-
- @only_when_on
- @fault_on_error
- def read_R(device):
- """
- _read_R reads the attribute value, stores it and returns it"
- """
- device.value_dict[self] = self.read_function()
- return device.value_dict[self]
-
- self.fget = read_R
-
- super().__init__(dtype=datatype, max_dim_y=max_dim_y, max_dim_x=max_dim_x, access=access, **kwargs)
-
- return
-
- def initial_value(self):
- """
- returns a numpy array filled with zeroes fit to the size of the attribute. Or if init_value is not the default None, return that value
- """
- if self.init_value is not None:
- return self.init_value
-
- if self.dim_y > 1:
- dims = (self.dim_x, self.dim_y)
- else:
- dims = (self.dim_x,)
-
- # x and y are swapped for numpy and Tango. to maintain tango conventions, x and y are swapped for numpy
- if len(dims) == 2:
- numpy_dims = tuple((dims[1], dims[0]))
- else:
- numpy_dims = dims
-
- value = numpy.zeros(numpy_dims, dtype=self.numpy_type)
- return value
-
- def set_comm_client(self, client):
- """
- takes a communications client as input arguments This client should be of a class containing a "get_mapping" function
- and return a read and write function that the wrapper will use to get/set data.
- """
- try:
- self.read_function, self.write_function = client.setup_attribute(self.comms_annotation, self)
- except Exception as e:
- def pass_func(value=None):
- pass
- logger.error("setting comm_client failed. using pass function instead")
-
- self.read_function = pass_func
- self.write_function = pass_func
-
- raise Exception("Exception while setting comm_client read/write functions. using pass function instead. %s") from e
+from tango.server import attribute
+from tango import AttrWriteType
+
+import numpy
+
+from src.wrappers import only_when_on, fault_on_error
+import logging
+logger = logging.getLogger()
+
+
+class attribute_wrapper(attribute):
+ """
+ Wraps all the attributes in a wrapper class to manage most of the redundant code behind the scenes
+ """
+
+ def __init__(self, comms_annotation=None, datatype=None, dims=(1,), access=AttrWriteType.READ, init_value=None, **kwargs):
+ """
+ wraps around the tango Attribute class. Provides an easier interface for 1d or 2d arrays. Also provides a way to abstract
+ managing the communications interface.
+ """
+
+ # ensure the type is a numpy array
+ if "numpy" not in str(datatype) and type(datatype) != str:
+ raise TypeError("Attribute needs to be a Tango-supported numpy or str type, but has type \"%s\"" % (datatype,))
+
+
+
+ self.comms_annotation = comms_annotation # store data that can be used by the comms interface. not used by the wrapper itself
+ self.numpy_type = datatype # tango changes our attribute to their representation (E.g numpy.int64 becomes "DevLong64")
+
+ self.init_value = init_value
+ max_dim_y = 0
+
+ # tango doesn't recognise numpy.str_, for consistencies sake we convert it here and hide this from the top level
+ # NOTE: discuss, idk if this is an important detail somewhere else
+ if datatype is numpy.str_:
+ datatype = str
+
+ # check if not scalar
+ if isinstance(dims, tuple):
+
+ # get first dimension
+ max_dim_x = dims[0]
+
+ # single dimension/spectrum requires the datatype to be wrapped in a tuple
+ datatype = (datatype,)
+
+ if len(dims) == 2:
+ # get second dimension
+ max_dim_y = dims[1]
+ # wrap the datatype tuple in another tuple for 2d arrays/images
+ datatype = (datatype,)
+ else:
+ # scalar, just set the single dimension
+ max_dim_x = 1
+
+
+ if access == AttrWriteType.READ_WRITE:
+ """ if the attribute is of READ_WRITE type, assign the RW and write function to it"""
+
+ @only_when_on
+ @fault_on_error
+ def read_RW(device):
+ # print("read_RW {}, {}x{}, {}, {}".format(me.name, me.dim_x, me.dim_y, me.attr_type, me.value))
+ """
+ read_RW returns the value that was last written to the attribute
+ """
+ try:
+ return device.value_dict[self]
+ except Exception as e:
+ raise Exception("Attribute read_RW function error, attempted to read value_dict with key: `%s`, are you sure this exists?", self) from e
+
+
+ @only_when_on
+ @fault_on_error
+ def write_RW(device, value):
+ """
+ _write_RW writes a value to this attribute
+ """
+ self.write_function(value)
+ device.value_dict[self] = value
+
+ self.fget = read_RW
+ self.fset = write_RW
+
+
+ else:
+ """ if the attribute is of READ type, assign the read function to it"""
+
+ @only_when_on
+ @fault_on_error
+ def read_R(device):
+ """
+ _read_R reads the attribute value, stores it and returns it"
+ """
+ device.value_dict[self] = self.read_function()
+ return device.value_dict[self]
+
+ self.fget = read_R
+
+ super().__init__(dtype=datatype, max_dim_y=max_dim_y, max_dim_x=max_dim_x, access=access, **kwargs)
+
+ return
+
+ def initial_value(self):
+ """
+ returns a numpy array filled with zeroes fit to the size of the attribute. Or if init_value is not the default None, return that value
+ """
+ if self.init_value is not None:
+ return self.init_value
+
+ if self.dim_y > 1:
+ dims = (self.dim_x, self.dim_y)
+ else:
+ dims = (self.dim_x,)
+
+ # x and y are swapped for numpy and Tango. to maintain tango conventions, x and y are swapped for numpy
+ if len(dims) == 2:
+ numpy_dims = tuple((dims[1], dims[0]))
+ else:
+ numpy_dims = dims
+
+ value = numpy.zeros(numpy_dims, dtype=self.numpy_type)
+ return value
+
+ def set_comm_client(self, client):
+ """
+ takes a communications client as input arguments This client should be of a class containing a "get_mapping" function
+ and return a read and write function that the wrapper will use to get/set data.
+ """
+ try:
+ self.read_function, self.write_function = client.setup_attribute(self.comms_annotation, self)
+ except Exception as e:
+ def pass_func(value=None):
+ pass
+ logger.error("setting comm_client failed. using pass function instead")
+
+ self.read_function = pass_func
+ self.write_function = pass_func
+
+ raise Exception("Exception while setting comm_client read/write functions. using pass function instead. %s") from e
diff --git a/devices/src/comms_client.py b/devices/src/comms_client.py
index 0cf7fb9801a91b8289fef480456e932bf2581626..789e9362382d70f657711b9724ae8fbee5df4038 100644
--- a/devices/src/comms_client.py
+++ b/devices/src/comms_client.py
@@ -1,136 +1,136 @@
-from threading import Thread
-import socket
-import time
-import numpy
-
-from tango import DevState
-
-
-class CommClient(Thread):
- """
- The ProtocolHandler class is the generic interface class between the tango attribute_wrapper and the outside world
- """
-
- def __init__(self, standby_func, fault_func, streams, try_interval=2):
- """
-
- """
- self.standby_func = standby_func
- self.fault_func = fault_func
- self.try_interval = try_interval
- self.streams = streams
- self.stopping = False
- self.connected = False
-
- super().__init__(daemon=True)
-
- def connect(self):
- """
- Function used to connect to the client.
- """
- self.connected = True
- return True
-
- def disconnect(self):
- """
- Function used to connect to the client.
- """
- self.connected = False
-
- def run(self):
-
- # Explicitly connect
- if not self.connect():
- # hardware or infra is down -- needs fixing first
- self.fault_func()
- return
-
- self.standby_func()
-
- self.stopping = False
- while not self.stopping:
- # keep trying to connect
- if not self.connected:
- if self.connect():
- self.standby_func()
- else:
- # we retry only once, to catch exotic network issues. if the infra or hardware is down,
- # our device cannot help, and must be reinitialised after the infra or hardware is fixed.
- self.fault_func()
- return
-
- # keep checking if the connection is still alive
- try:
- while not self.stopping:
- self.ping()
- time.sleep(self.try_interval)
- except Exception as e:
- self.streams.error_stream("Fault condition in communication detected.", e)
-
- # technically, we may not have dropped the connection, but encounter a different error. so explicitly disconnect.
- self.disconnect()
-
- # signal that we're disconnected
- self.fault_func()
-
- def ping(self):
- pass
-
- def stop(self):
- """
- Stop connecting & disconnect. Can take a few seconds for the timeouts to hit.
- """
-
- if not self.ident:
- # have not yet been started, so nothing to do
- return
-
- self.stopping = True
- self.join()
-
- self.disconnect()
-
- def setup_attribute(self, annotation, attribute):
- """
- This function is responsible for providing the attribute_wrapper with a read/write function
- How this is done is implementation specific.
- The setup-attribute has access to the comms_annotation provided to the attribute wrapper to pass along to the comms client
- as well as a reference to the attribute itself.
-
- It should do this by first calling: _setup_annotation and setup_value_conversion to get all data necceacry to configure the read/write functions.
- It should then return the read and write functions to the attribute.
-
- MANDATORY:
- annotation_outputs = _setup_annotation(annotation)
- attribute_outputs = _setup_annotation(attribute)
- (note: outputs are up to the user)
-
- REQUIRED: provide read and write functions to return, there are no restrictions on how these should be provided,
- except that the read function takes a single input value and the write function returns a single value
-
- MANDATORY:
- return read_function, write_function
-
- Examples:
- - File system: get_mapping returns functions that read/write a fixed
- number of bytes at a fixed location in a file. (SEEK)
- - OPC-UA: traverse the OPC-UA tree until the node is found.
- Then return the read/write functions for that node which automatically
- convert values between Python and OPC-UA.
- """
- raise NotImplementedError("the setup_attribute must be implemented and provide return a valid read/write function for the attribute")
-
- def _setup_annotation(self, annotation):
- """
- This function is responsible for handling the annotation data provided by the attribute to configure the read/write function the client must provide.
- This function should be called by setup_attribute
- """
- raise NotImplementedError("the _setup_annotation must be implemented, content and outputs are up to the user")
-
- def setup_value_conversion(self, attribute):
- """
- this function is responsible for setting up the value conversion between the client and the attribute.
- This function should be called by setup_attribute
- """
- raise NotImplementedError("the setup_value_conversion must be implemented, content and outputs are up to the user")
-
+from threading import Thread
+import socket
+import time
+import numpy
+
+from tango import DevState
+
+
+class CommClient(Thread):
+ """
+ The ProtocolHandler class is the generic interface class between the tango attribute_wrapper and the outside world
+ """
+
+ def __init__(self, standby_func, fault_func, streams, try_interval=2):
+ """
+
+ """
+ self.standby_func = standby_func
+ self.fault_func = fault_func
+ self.try_interval = try_interval
+ self.streams = streams
+ self.stopping = False
+ self.connected = False
+
+ super().__init__(daemon=True)
+
+ def connect(self):
+ """
+ Function used to connect to the client.
+ """
+ self.connected = True
+ return True
+
+ def disconnect(self):
+ """
+ Function used to connect to the client.
+ """
+ self.connected = False
+
+ def run(self):
+
+ # Explicitly connect
+ if not self.connect():
+ # hardware or infra is down -- needs fixing first
+ self.fault_func()
+ return
+
+ self.standby_func()
+
+ self.stopping = False
+ while not self.stopping:
+ # keep trying to connect
+ if not self.connected:
+ if self.connect():
+ self.standby_func()
+ else:
+ # we retry only once, to catch exotic network issues. if the infra or hardware is down,
+ # our device cannot help, and must be reinitialised after the infra or hardware is fixed.
+ self.fault_func()
+ return
+
+ # keep checking if the connection is still alive
+ try:
+ while not self.stopping:
+ self.ping()
+ time.sleep(self.try_interval)
+ except Exception as e:
+ self.streams.error_stream("Fault condition in communication detected.", e)
+
+ # technically, we may not have dropped the connection, but encounter a different error. so explicitly disconnect.
+ self.disconnect()
+
+ # signal that we're disconnected
+ self.fault_func()
+
+ def ping(self):
+ pass
+
+ def stop(self):
+ """
+ Stop connecting & disconnect. Can take a few seconds for the timeouts to hit.
+ """
+
+ if not self.ident:
+ # have not yet been started, so nothing to do
+ return
+
+ self.stopping = True
+ self.join()
+
+ self.disconnect()
+
+ def setup_attribute(self, annotation, attribute):
+ """
+ This function is responsible for providing the attribute_wrapper with a read/write function
+ How this is done is implementation specific.
+ The setup-attribute has access to the comms_annotation provided to the attribute wrapper to pass along to the comms client
+ as well as a reference to the attribute itself.
+
+ It should do this by first calling: _setup_annotation and setup_value_conversion to get all data necceacry to configure the read/write functions.
+ It should then return the read and write functions to the attribute.
+
+ MANDATORY:
+ annotation_outputs = _setup_annotation(annotation)
+ attribute_outputs = _setup_annotation(attribute)
+ (note: outputs are up to the user)
+
+ REQUIRED: provide read and write functions to return, there are no restrictions on how these should be provided,
+ except that the read function takes a single input value and the write function returns a single value
+
+ MANDATORY:
+ return read_function, write_function
+
+ Examples:
+ - File system: get_mapping returns functions that read/write a fixed
+ number of bytes at a fixed location in a file. (SEEK)
+ - OPC-UA: traverse the OPC-UA tree until the node is found.
+ Then return the read/write functions for that node which automatically
+ convert values between Python and OPC-UA.
+ """
+ raise NotImplementedError("the setup_attribute must be implemented and provide return a valid read/write function for the attribute")
+
+ def _setup_annotation(self, annotation):
+ """
+ This function is responsible for handling the annotation data provided by the attribute to configure the read/write function the client must provide.
+ This function should be called by setup_attribute
+ """
+ raise NotImplementedError("the _setup_annotation must be implemented, content and outputs are up to the user")
+
+ def setup_value_conversion(self, attribute):
+ """
+ this function is responsible for setting up the value conversion between the client and the attribute.
+ This function should be called by setup_attribute
+ """
+ raise NotImplementedError("the setup_value_conversion must be implemented, content and outputs are up to the user")
+
diff --git a/devices/src/hardware_device.py b/devices/src/hardware_device.py
index 36f89cdfe2fed2dae107722c589bc34fb82328e4..99e86b0c5db611507aa9138e222721c8ec720736 100644
--- a/devices/src/hardware_device.py
+++ b/devices/src/hardware_device.py
@@ -1,178 +1,178 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of the PCC project
-#
-#
-#
-# Distributed under the terms of the APACHE license.
-# See LICENSE.txt for more info.
-
-""" PCC Device Server for LOFAR2.0
-
-"""
-
-# PyTango imports
-from tango.server import Device, command
-from tango import DevState, DebugIt
-# Additional import
-
-from src.attribute_wrapper import *
-from src.lofar_logging import log_exceptions
-
-
-__all__ = ["hardware_device"]
-
-from src.wrappers import only_in_states
-
-
-class hardware_device(Device):
- """
-
- **Properties:**
-
- States are as follows:
- INIT = Device is initialising.
- STANDBY = Device is initialised, but pends external configuration and an explicit turning on,
- ON = Device is fully configured, functional, controls the hardware, and is possibly actively running,
- FAULT = Device detected an unrecoverable error, and is thus malfunctional,
- OFF = Device is turned off, drops connection to the hardware,
-
- The following state transitions are implemented:
- boot -> OFF: Triggered by tango. Device will be instantiated,
- OFF -> INIT: Triggered by device. Device will initialise (connect to hardware, other devices),
- INIT -> STANDBY: Triggered by device. Device is initialised, and is ready for additional configuration by the user,
- STANDBY -> ON: Triggered by user. Device reports to be functional,
- * -> FAULT: Triggered by device. Device has degraded to malfunctional, for example because the connection to the hardware is lost,
- * -> FAULT: Triggered by user. Emulate a forced malfunction for integration testing purposes,
- * -> OFF: Triggered by user. Device is turned off. Triggered by the Off() command,
- FAULT -> INIT: Triggered by user. Device is reinitialised to recover from an error,
-
- The user triggers their transitions by the commands reflecting the target state (Initialise(), On(), Fault()).
- """
-
- @classmethod
- def attr_list(cls):
- """ Return a list of all the attribute_wrapper members of this class. """
- return [v for k, v in cls.__dict__.items() if type(v) == attribute_wrapper]
-
- def setup_value_dict(self):
- """ set the initial value for all the attribute wrapper objects"""
-
- self.value_dict = {i: i.initial_value() for i in self.attr_list()}
-
- @log_exceptions()
- def init_device(self):
- """ Instantiates the device in the OFF state. """
-
- # NOTE: Will delete_device first, if necessary
- Device.init_device(self)
-
- self.set_state(DevState.OFF)
-
- # --------
- # Commands
- # --------
-
- @command()
- @only_in_states([DevState.FAULT, DevState.OFF])
- @DebugIt()
- def Initialise(self):
- """
- Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
-
- :return:None
- """
- self.set_state(DevState.INIT)
- self.setup_value_dict()
- self.initialise()
- self.standby()
- self.set_state(DevState.STANDBY)
-
- @only_in_states([DevState.INIT])
- def Standby(self):
- """
- Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
-
- :return:None
- """
-
- self.standby()
- self.set_state(DevState.STANDBY)
-
- @command()
- @only_in_states([DevState.STANDBY])
- @DebugIt()
- def On(self):
- """
- Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
-
- :return:None
- """
- self.on()
- self.set_state(DevState.ON)
-
- @command()
- @DebugIt()
- def Off(self):
- """
- Command to ask for shutdown of this device.
-
- :return:None
- """
- if self.get_state() == DevState.OFF:
- # Already off. Don't complain.
- return
-
- # Turn off
- self.set_state(DevState.OFF)
-
- self.off()
-
- # Turn off again, in case of race conditions through reconnecting
- self.set_state(DevState.OFF)
-
- @command()
- @only_in_states([DevState.ON, DevState.INIT, DevState.STANDBY])
- @DebugIt()
- def Fault(self):
- """
- FAULT state is used to indicate our connection with the OPC-UA server is down.
-
- This device will try to reconnect once, and transition to the ON state on success.
-
- If reconnecting fails, the user needs to call Initialise() to retry to restart this device.
-
- :return:None
- """
- self.fault()
- self.set_state(DevState.FAULT)
-
-
- # functions that can be overloaded
- def fault(self):
- pass
- def off(self):
- pass
- def on(self):
- pass
- def standby(self):
- pass
- def initialise(self):
- pass
-
- def always_executed_hook(self):
- """Method always executed before any TANGO command is executed."""
- pass
-
- @log_exceptions()
- def delete_device(self):
- """Hook to delete resources allocated in init_device.
-
- This method allows for any memory or other resources allocated in the
- init_device method to be released. This method is called by the device
- destructor and by the device Init command (a Tango built-in).
- """
- self.debug_stream("Shutting down...")
-
- self.Off()
- self.debug_stream("Shut down. Good bye.")
+# -*- coding: utf-8 -*-
+#
+# This file is part of the PCC project
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+""" PCC Device Server for LOFAR2.0
+
+"""
+
+# PyTango imports
+from tango.server import Device, command
+from tango import DevState, DebugIt
+# Additional import
+
+from src.attribute_wrapper import *
+from src.lofar_logging import log_exceptions
+
+
+__all__ = ["hardware_device"]
+
+from src.wrappers import only_in_states
+
+
+class hardware_device(Device):
+ """
+
+ **Properties:**
+
+ States are as follows:
+ INIT = Device is initialising.
+ STANDBY = Device is initialised, but pends external configuration and an explicit turning on,
+ ON = Device is fully configured, functional, controls the hardware, and is possibly actively running,
+ FAULT = Device detected an unrecoverable error, and is thus malfunctional,
+ OFF = Device is turned off, drops connection to the hardware,
+
+ The following state transitions are implemented:
+ boot -> OFF: Triggered by tango. Device will be instantiated,
+ OFF -> INIT: Triggered by device. Device will initialise (connect to hardware, other devices),
+ INIT -> STANDBY: Triggered by device. Device is initialised, and is ready for additional configuration by the user,
+ STANDBY -> ON: Triggered by user. Device reports to be functional,
+ * -> FAULT: Triggered by device. Device has degraded to malfunctional, for example because the connection to the hardware is lost,
+ * -> FAULT: Triggered by user. Emulate a forced malfunction for integration testing purposes,
+ * -> OFF: Triggered by user. Device is turned off. Triggered by the Off() command,
+ FAULT -> INIT: Triggered by user. Device is reinitialised to recover from an error,
+
+ The user triggers their transitions by the commands reflecting the target state (Initialise(), On(), Fault()).
+ """
+
+ @classmethod
+ def attr_list(cls):
+ """ Return a list of all the attribute_wrapper members of this class. """
+ return [v for k, v in cls.__dict__.items() if type(v) == attribute_wrapper]
+
+ def setup_value_dict(self):
+ """ set the initial value for all the attribute wrapper objects"""
+
+ self.value_dict = {i: i.initial_value() for i in self.attr_list()}
+
+ @log_exceptions()
+ def init_device(self):
+ """ Instantiates the device in the OFF state. """
+
+ # NOTE: Will delete_device first, if necessary
+ Device.init_device(self)
+
+ self.set_state(DevState.OFF)
+
+ # --------
+ # Commands
+ # --------
+
+ @command()
+ @only_in_states([DevState.FAULT, DevState.OFF])
+ @DebugIt()
+ def Initialise(self):
+ """
+ Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
+
+ :return:None
+ """
+ self.set_state(DevState.INIT)
+ self.setup_value_dict()
+ self.initialise()
+ self.standby()
+ self.set_state(DevState.STANDBY)
+
+ @only_in_states([DevState.INIT])
+ def Standby(self):
+ """
+ Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
+
+ :return:None
+ """
+
+ self.standby()
+ self.set_state(DevState.STANDBY)
+
+ @command()
+ @only_in_states([DevState.STANDBY])
+ @DebugIt()
+ def On(self):
+ """
+ Command to ask for initialisation of this device. Can only be called in FAULT or OFF state.
+
+ :return:None
+ """
+ self.on()
+ self.set_state(DevState.ON)
+
+ @command()
+ @DebugIt()
+ def Off(self):
+ """
+ Command to ask for shutdown of this device.
+
+ :return:None
+ """
+ if self.get_state() == DevState.OFF:
+ # Already off. Don't complain.
+ return
+
+ # Turn off
+ self.set_state(DevState.OFF)
+
+ self.off()
+
+ # Turn off again, in case of race conditions through reconnecting
+ self.set_state(DevState.OFF)
+
+ @command()
+ @only_in_states([DevState.ON, DevState.INIT, DevState.STANDBY])
+ @DebugIt()
+ def Fault(self):
+ """
+ FAULT state is used to indicate our connection with the OPC-UA server is down.
+
+ This device will try to reconnect once, and transition to the ON state on success.
+
+ If reconnecting fails, the user needs to call Initialise() to retry to restart this device.
+
+ :return:None
+ """
+ self.fault()
+ self.set_state(DevState.FAULT)
+
+
+ # functions that can be overloaded
+ def fault(self):
+ pass
+ def off(self):
+ pass
+ def on(self):
+ pass
+ def standby(self):
+ pass
+ def initialise(self):
+ pass
+
+ def always_executed_hook(self):
+ """Method always executed before any TANGO command is executed."""
+ pass
+
+ @log_exceptions()
+ def delete_device(self):
+ """Hook to delete resources allocated in init_device.
+
+ This method allows for any memory or other resources allocated in the
+ init_device method to be released. This method is called by the device
+ destructor and by the device Init command (a Tango built-in).
+ """
+ self.debug_stream("Shutting down...")
+
+ self.Off()
+ self.debug_stream("Shut down. Good bye.")
diff --git a/devices/test_device.py b/devices/test_device.py
index 27bdbfcb079e5019be6826ad8e7d3354ac296722..77044f3bd8c2d38bb803244a44d06a6b11a28233 100644
--- a/devices/test_device.py
+++ b/devices/test_device.py
@@ -1,91 +1,91 @@
-# -*- coding: utf-8 -*-
-#
-# This file is part of the PCC project
-#
-#
-#
-# Distributed under the terms of the APACHE license.
-# See LICENSE.txt for more info.
-
-""" PCC Device Server for LOFAR2.0
-
-"""
-
-# PyTango imports
-from tango.server import run
-from tango.server import device_property
-from tango import DevState
-# Additional import
-
-from clients.test_client import example_client
-from src.attribute_wrapper import *
-from src.hardware_device import *
-
-__all__ = ["test_device", "main"]
-
-
-class test_device(hardware_device):
-
- # -----------------
- # Device Properties
- # -----------------
-
- OPC_Server_Name = device_property(
- dtype='DevString',
- )
-
- OPC_Server_Port = device_property(
- dtype='DevULong',
- )
-
- OPC_Time_Out = device_property(
- dtype='DevDouble',
- )
-
- # ----------
- # Attributes
- # ----------
- bool_scalar_R = attribute_wrapper(comms_annotation="numpy.bool_ type read scalar", datatype=numpy.bool_)
- bool_scalar_RW = attribute_wrapper(comms_annotation="numpy.bool_ type read/write scalar", datatype=numpy.bool_, access=AttrWriteType.READ_WRITE)
-
- int64_spectrum_R = attribute_wrapper(comms_annotation="numpy.int64 type read spectrum (len = 8)", datatype=numpy.int64, dims=(8,))
- str_spectrum_RW = attribute_wrapper(comms_annotation="numpy.str type read/write spectrum (len = 8)", datatype=numpy.str_, dims=(8,), access=AttrWriteType.READ_WRITE)
-
- double_image_R = attribute_wrapper(comms_annotation="numpy.double type read image (dims = 2x8)", datatype=numpy.double, dims=(2, 8))
- double_image_RW = attribute_wrapper(comms_annotation="numpy.double type read/write image (dims = 8x2)", datatype=numpy.double, dims=(8, 2), access=AttrWriteType.READ_WRITE)
-
- int32_scalar_R = attribute_wrapper(comms_annotation="numpy.int32 type read scalar", datatype=numpy.int32)
- uint16_spectrum_RW = attribute_wrapper(comms_annotation="numpy.uint16 type read/write spectrum (len = 8)", datatype=numpy.uint16, dims=(8,), access=AttrWriteType.READ_WRITE)
- float32_image_R = attribute_wrapper(comms_annotation="numpy.float32 type read image (dims = 8x2)", datatype=numpy.float32, dims=(8, 2))
- uint8_image_RW = attribute_wrapper(comms_annotation="numpy.uint8 type read/write image (dims = 2x8)", datatype=numpy.uint8, dims=(2, 8), access=AttrWriteType.READ_WRITE)
-
- # --------
- # overloaded functions
- # --------
- def initialise(self):
- """ user code here. is called when the sate is set to INIT """
- """Initialises the attributes and properties of the PCC."""
-
- self.set_state(DevState.INIT)
-
-
- #set up the OPC ua client
- self.example_client = example_client(self.Standby, self.Fault, self)
-
- # map an access helper class
- for i in self.attr_list():
- i.set_comm_client(self.example_client)
-
-
- self.example_client.start()
-
-# ----------
-# Run server
-# ----------
-def main(args=None, **kwargs):
- """Main function of the example module."""
- return run((test_device,), args=args, **kwargs)
-
-
-if __name__ == '__main__':
- main()
+# -*- coding: utf-8 -*-
+#
+# This file is part of the PCC project
+#
+#
+#
+# Distributed under the terms of the APACHE license.
+# See LICENSE.txt for more info.
+
+""" PCC Device Server for LOFAR2.0
+
+"""
+
+# PyTango imports
+from tango.server import run
+from tango.server import device_property
+from tango import DevState
+# Additional import
+
+from clients.test_client import example_client
+from src.attribute_wrapper import *
+from src.hardware_device import *
+
+__all__ = ["test_device", "main"]
+
+
+class test_device(hardware_device):
+
+ # -----------------
+ # Device Properties
+ # -----------------
+
+ OPC_Server_Name = device_property(
+ dtype='DevString',
+ )
+
+ OPC_Server_Port = device_property(
+ dtype='DevULong',
+ )
+
+ OPC_Time_Out = device_property(
+ dtype='DevDouble',
+ )
+
+ # ----------
+ # Attributes
+ # ----------
+ bool_scalar_R = attribute_wrapper(comms_annotation="numpy.bool_ type read scalar", datatype=numpy.bool_)
+ bool_scalar_RW = attribute_wrapper(comms_annotation="numpy.bool_ type read/write scalar", datatype=numpy.bool_, access=AttrWriteType.READ_WRITE)
+
+ int64_spectrum_R = attribute_wrapper(comms_annotation="numpy.int64 type read spectrum (len = 8)", datatype=numpy.int64, dims=(8,))
+ str_spectrum_RW = attribute_wrapper(comms_annotation="numpy.str type read/write spectrum (len = 8)", datatype=numpy.str_, dims=(8,), access=AttrWriteType.READ_WRITE)
+
+ double_image_R = attribute_wrapper(comms_annotation="numpy.double type read image (dims = 2x8)", datatype=numpy.double, dims=(2, 8))
+ double_image_RW = attribute_wrapper(comms_annotation="numpy.double type read/write image (dims = 8x2)", datatype=numpy.double, dims=(8, 2), access=AttrWriteType.READ_WRITE)
+
+ int32_scalar_R = attribute_wrapper(comms_annotation="numpy.int32 type read scalar", datatype=numpy.int32)
+ uint16_spectrum_RW = attribute_wrapper(comms_annotation="numpy.uint16 type read/write spectrum (len = 8)", datatype=numpy.uint16, dims=(8,), access=AttrWriteType.READ_WRITE)
+ float32_image_R = attribute_wrapper(comms_annotation="numpy.float32 type read image (dims = 8x2)", datatype=numpy.float32, dims=(8, 2))
+ uint8_image_RW = attribute_wrapper(comms_annotation="numpy.uint8 type read/write image (dims = 2x8)", datatype=numpy.uint8, dims=(2, 8), access=AttrWriteType.READ_WRITE)
+
+ # --------
+ # overloaded functions
+ # --------
+ def initialise(self):
+ """ user code here. is called when the sate is set to INIT """
+ """Initialises the attributes and properties of the PCC."""
+
+ self.set_state(DevState.INIT)
+
+
+ #set up the OPC ua client
+ self.example_client = example_client(self.Standby, self.Fault, self)
+
+ # map an access helper class
+ for i in self.attr_list():
+ i.set_comm_client(self.example_client)
+
+
+ self.example_client.start()
+
+# ----------
+# Run server
+# ----------
+def main(args=None, **kwargs):
+ """Main function of the example module."""
+ return run((test_device,), args=args, **kwargs)
+
+
+if __name__ == '__main__':
+ main()