volttron-core 2.0.0rc0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. volttron_core-2.0.0rc0/LICENSE +216 -0
  2. volttron_core-2.0.0rc0/PKG-INFO +124 -0
  3. volttron_core-2.0.0rc0/README.md +82 -0
  4. volttron_core-2.0.0rc0/pyproject.toml +83 -0
  5. volttron_core-2.0.0rc0/src/volttron/client/__init__.py +67 -0
  6. volttron_core-2.0.0rc0/src/volttron/client/commands/__init__.py +192 -0
  7. volttron_core-2.0.0rc0/src/volttron/client/commands/auth_parser.py +962 -0
  8. volttron_core-2.0.0rc0/src/volttron/client/commands/authz_parser.py +603 -0
  9. volttron_core-2.0.0rc0/src/volttron/client/commands/config.py +126 -0
  10. volttron_core-2.0.0rc0/src/volttron/client/commands/config_store_parser.py +286 -0
  11. volttron_core-2.0.0rc0/src/volttron/client/commands/connection.py +91 -0
  12. volttron_core-2.0.0rc0/src/volttron/client/commands/control.py +2481 -0
  13. volttron_core-2.0.0rc0/src/volttron/client/commands/control_parser.py +808 -0
  14. volttron_core-2.0.0rc0/src/volttron/client/commands/install_agents.py +346 -0
  15. volttron_core-2.0.0rc0/src/volttron/client/commands/rpc_parser.py +232 -0
  16. volttron_core-2.0.0rc0/src/volttron/client/decorators.py +201 -0
  17. volttron_core-2.0.0rc0/src/volttron/client/known_identities.py +78 -0
  18. volttron_core-2.0.0rc0/src/volttron/client/logs.py +111 -0
  19. volttron_core-2.0.0rc0/src/volttron/client/messaging/__init__.py +23 -0
  20. volttron_core-2.0.0rc0/src/volttron/client/messaging/headers.py +102 -0
  21. volttron_core-2.0.0rc0/src/volttron/client/messaging/health.py +169 -0
  22. volttron_core-2.0.0rc0/src/volttron/client/messaging/topics.py +185 -0
  23. volttron_core-2.0.0rc0/src/volttron/client/messaging/utils.py +178 -0
  24. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/__init__.py +231 -0
  25. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/core.py +887 -0
  26. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/decorators.py +150 -0
  27. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/dispatch.py +56 -0
  28. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/errors.py +79 -0
  29. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/example.py +111 -0
  30. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/results.py +79 -0
  31. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/__init__.py +37 -0
  32. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/auth.py +396 -0
  33. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/base.py +26 -0
  34. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/configstore.py +481 -0
  35. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/health.py +171 -0
  36. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/heartbeat.py +143 -0
  37. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/hello.py +113 -0
  38. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/peerlist.py +160 -0
  39. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/ping.py +86 -0
  40. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/pubsub.py +856 -0
  41. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/query.py +76 -0
  42. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/rpc.py +507 -0
  43. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/subsystems/web.py +227 -0
  44. volttron_core-2.0.0rc0/src/volttron/client/vip/agent/utils.py +59 -0
  45. volttron_core-2.0.0rc0/src/volttron/decorators.py +366 -0
  46. volttron_core-2.0.0rc0/src/volttron/loader.py +89 -0
  47. volttron_core-2.0.0rc0/src/volttron/py.typed +0 -0
  48. volttron_core-2.0.0rc0/src/volttron/server/__init__.py +23 -0
  49. volttron_core-2.0.0rc0/src/volttron/server/__main__.py +105 -0
  50. volttron_core-2.0.0rc0/src/volttron/server/aip.py +1306 -0
  51. volttron_core-2.0.0rc0/src/volttron/server/async_.py +102 -0
  52. volttron_core-2.0.0rc0/src/volttron/server/containers.py +491 -0
  53. volttron_core-2.0.0rc0/src/volttron/server/decorators.py +406 -0
  54. volttron_core-2.0.0rc0/src/volttron/server/logs.py +384 -0
  55. volttron_core-2.0.0rc0/src/volttron/server/run_server.py +902 -0
  56. volttron_core-2.0.0rc0/src/volttron/server/scheduling.py +348 -0
  57. volttron_core-2.0.0rc0/src/volttron/server/server_argparser.py +564 -0
  58. volttron_core-2.0.0rc0/src/volttron/server/server_options.py +234 -0
  59. volttron_core-2.0.0rc0/src/volttron/server/server_ui.py +573 -0
  60. volttron_core-2.0.0rc0/src/volttron/server/serviceloader.py +186 -0
  61. volttron_core-2.0.0rc0/src/volttron/server/tracking.py +114 -0
  62. volttron_core-2.0.0rc0/src/volttron/server/wheel_wrap.py +442 -0
  63. volttron_core-2.0.0rc0/src/volttron/services/config_store/__init__.py +25 -0
  64. volttron_core-2.0.0rc0/src/volttron/services/config_store/config_store_service.py +532 -0
  65. volttron_core-2.0.0rc0/src/volttron/services/control/__init__.py +25 -0
  66. volttron_core-2.0.0rc0/src/volttron/services/control/control_service.py +538 -0
  67. volttron_core-2.0.0rc0/src/volttron/services/health/__init__.py +25 -0
  68. volttron_core-2.0.0rc0/src/volttron/services/health/health_service.py +148 -0
  69. volttron_core-2.0.0rc0/src/volttron/types/__init__.py +237 -0
  70. volttron_core-2.0.0rc0/src/volttron/types/agent_context.py +119 -0
  71. volttron_core-2.0.0rc0/src/volttron/types/auth/__init__.py +20 -0
  72. volttron_core-2.0.0rc0/src/volttron/types/auth/auth_credentials.py +212 -0
  73. volttron_core-2.0.0rc0/src/volttron/types/auth/auth_service.py +276 -0
  74. volttron_core-2.0.0rc0/src/volttron/types/auth/authz_types.py +876 -0
  75. volttron_core-2.0.0rc0/src/volttron/types/blinker_events.py +3 -0
  76. volttron_core-2.0.0rc0/src/volttron/types/events.py +3 -0
  77. volttron_core-2.0.0rc0/src/volttron/types/factories.py +43 -0
  78. volttron_core-2.0.0rc0/src/volttron/types/known_host.py +82 -0
  79. volttron_core-2.0.0rc0/src/volttron/types/message.py +29 -0
  80. volttron_core-2.0.0rc0/src/volttron/types/peer.py +80 -0
  81. volttron_core-2.0.0rc0/src/volttron/types/server_config.py +241 -0
  82. volttron_core-2.0.0rc0/src/volttron/types/service_interface.py +33 -0
  83. volttron_core-2.0.0rc0/src/volttron/utils/__init__.py +173 -0
  84. volttron_core-2.0.0rc0/src/volttron/utils/argparser.py +569 -0
  85. volttron_core-2.0.0rc0/src/volttron/utils/certs.py +1075 -0
  86. volttron_core-2.0.0rc0/src/volttron/utils/commands.py +191 -0
  87. volttron_core-2.0.0rc0/src/volttron/utils/context.py +188 -0
  88. volttron_core-2.0.0rc0/src/volttron/utils/dynamic_helper.py +110 -0
  89. volttron_core-2.0.0rc0/src/volttron/utils/file_access.py +61 -0
  90. volttron_core-2.0.0rc0/src/volttron/utils/filewatch.py +123 -0
  91. volttron_core-2.0.0rc0/src/volttron/utils/frozendict.py +44 -0
  92. volttron_core-2.0.0rc0/src/volttron/utils/identities.py +62 -0
  93. volttron_core-2.0.0rc0/src/volttron/utils/jsonapi.py +78 -0
  94. volttron_core-2.0.0rc0/src/volttron/utils/jsonrpc.py +451 -0
  95. volttron_core-2.0.0rc0/src/volttron/utils/math_utils.py +68 -0
  96. volttron_core-2.0.0rc0/src/volttron/utils/messagebus.py +66 -0
  97. volttron_core-2.0.0rc0/src/volttron/utils/network.py +105 -0
  98. volttron_core-2.0.0rc0/src/volttron/utils/persistance.py +151 -0
  99. volttron_core-2.0.0rc0/src/volttron/utils/scheduling.py +362 -0
  100. volttron_core-2.0.0rc0/src/volttron/utils/storeutils.py +106 -0
  101. volttron_core-2.0.0rc0/src/volttron/utils/time.py +209 -0
  102. volttron_core-2.0.0rc0/src/volttron/utils/version.py +77 -0
@@ -0,0 +1,216 @@
1
+ Copyright 2022 Battelle Memorial Institute
2
+
3
+ Licensed under the Apache License, Version 2.0 (the "License"); you may not
4
+ use this file except in compliance with the License. You may obtain a copy
5
+ of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12
+ License for the specific language governing permissions and limitations
13
+ under the License.
14
+
15
+
16
+ Apache License
17
+ Version 2.0, January 2004
18
+ http://www.apache.org/licenses/
19
+
20
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
21
+
22
+ 1. Definitions.
23
+
24
+ "License" shall mean the terms and conditions for use, reproduction,
25
+ and distribution as defined by Sections 1 through 9 of this document.
26
+
27
+ "Licensor" shall mean the copyright owner or entity authorized by
28
+ the copyright owner that is granting the License.
29
+
30
+ "Legal Entity" shall mean the union of the acting entity and all
31
+ other entities that control, are controlled by, or are under common
32
+ control with that entity. For the purposes of this definition,
33
+ "control" means (i) the power, direct or indirect, to cause the
34
+ direction or management of such entity, whether by contract or
35
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
36
+ outstanding shares, or (iii) beneficial ownership of such entity.
37
+
38
+ "You" (or "Your") shall mean an individual or Legal Entity
39
+ exercising permissions granted by this License.
40
+
41
+ "Source" form shall mean the preferred form for making modifications,
42
+ including but not limited to software source code, documentation
43
+ source, and configuration files.
44
+
45
+ "Object" form shall mean any form resulting from mechanical
46
+ transformation or translation of a Source form, including but
47
+ not limited to compiled object code, generated documentation,
48
+ and conversions to other media types.
49
+
50
+ "Work" shall mean the work of authorship, whether in Source or
51
+ Object form, made available under the License, as indicated by a
52
+ copyright notice that is included in or attached to the work
53
+ (an example is provided in the Appendix below).
54
+
55
+ "Derivative Works" shall mean any work, whether in Source or Object
56
+ form, that is based on (or derived from) the Work and for which the
57
+ editorial revisions, annotations, elaborations, or other modifications
58
+ represent, as a whole, an original work of authorship. For the purposes
59
+ of this License, Derivative Works shall not include works that remain
60
+ separable from, or merely link (or bind by name) to the interfaces of,
61
+ the Work and Derivative Works thereof.
62
+
63
+ "Contribution" shall mean any work of authorship, including
64
+ the original version of the Work and any modifications or additions
65
+ to that Work or Derivative Works thereof, that is intentionally
66
+ submitted to Licensor for inclusion in the Work by the copyright owner
67
+ or by an individual or Legal Entity authorized to submit on behalf of
68
+ the copyright owner. For the purposes of this definition, "submitted"
69
+ means any form of electronic, verbal, or written communication sent
70
+ to the Licensor or its representatives, including but not limited to
71
+ communication on electronic mailing lists, source code control systems,
72
+ and issue tracking systems that are managed by, or on behalf of, the
73
+ Licensor for the purpose of discussing and improving the Work, but
74
+ excluding communication that is conspicuously marked or otherwise
75
+ designated in writing by the copyright owner as "Not a Contribution."
76
+
77
+ "Contributor" shall mean Licensor and any individual or Legal Entity
78
+ on behalf of whom a Contribution has been received by Licensor and
79
+ subsequently incorporated within the Work.
80
+
81
+ 2. Grant of Copyright License. Subject to the terms and conditions of
82
+ this License, each Contributor hereby grants to You a perpetual,
83
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84
+ copyright license to reproduce, prepare Derivative Works of,
85
+ publicly display, publicly perform, sublicense, and distribute the
86
+ Work and such Derivative Works in Source or Object form.
87
+
88
+ 3. Grant of Patent License. Subject to the terms and conditions of
89
+ this License, each Contributor hereby grants to You a perpetual,
90
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
91
+ (except as stated in this section) patent license to make, have made,
92
+ use, offer to sell, sell, import, and otherwise transfer the Work,
93
+ where such license applies only to those patent claims licensable
94
+ by such Contributor that are necessarily infringed by their
95
+ Contribution(s) alone or by combination of their Contribution(s)
96
+ with the Work to which such Contribution(s) was submitted. If You
97
+ institute patent litigation against any entity (including a
98
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
99
+ or a Contribution incorporated within the Work constitutes direct
100
+ or contributory patent infringement, then any patent licenses
101
+ granted to You under this License for that Work shall terminate
102
+ as of the date such litigation is filed.
103
+
104
+ 4. Redistribution. You may reproduce and distribute copies of the
105
+ Work or Derivative Works thereof in any medium, with or without
106
+ modifications, and in Source or Object form, provided that You
107
+ meet the following conditions:
108
+
109
+ (a) You must give any other recipients of the Work or
110
+ Derivative Works a copy of this License; and
111
+
112
+ (b) You must cause any modified files to carry prominent notices
113
+ stating that You changed the files; and
114
+
115
+ (c) You must retain, in the Source form of any Derivative Works
116
+ that You distribute, all copyright, patent, trademark, and
117
+ attribution notices from the Source form of the Work,
118
+ excluding those notices that do not pertain to any part of
119
+ the Derivative Works; and
120
+
121
+ (d) If the Work includes a "NOTICE" text file as part of its
122
+ distribution, then any Derivative Works that You distribute must
123
+ include a readable copy of the attribution notices contained
124
+ within such NOTICE file, excluding those notices that do not
125
+ pertain to any part of the Derivative Works, in at least one
126
+ of the following places: within a NOTICE text file distributed
127
+ as part of the Derivative Works; within the Source form or
128
+ documentation, if provided along with the Derivative Works; or,
129
+ within a display generated by the Derivative Works, if and
130
+ wherever such third-party notices normally appear. The contents
131
+ of the NOTICE file are for informational purposes only and
132
+ do not modify the License. You may add Your own attribution
133
+ notices within Derivative Works that You distribute, alongside
134
+ or as an addendum to the NOTICE text from the Work, provided
135
+ that such additional attribution notices cannot be construed
136
+ as modifying the License.
137
+
138
+ You may add Your own copyright statement to Your modifications and
139
+ may provide additional or different license terms and conditions
140
+ for use, reproduction, or distribution of Your modifications, or
141
+ for any such Derivative Works as a whole, provided Your use,
142
+ reproduction, and distribution of the Work otherwise complies with
143
+ the conditions stated in this License.
144
+
145
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
146
+ any Contribution intentionally submitted for inclusion in the Work
147
+ by You to the Licensor shall be under the terms and conditions of
148
+ this License, without any additional terms or conditions.
149
+ Notwithstanding the above, nothing herein shall supersede or modify
150
+ the terms of any separate license agreement you may have executed
151
+ with Licensor regarding such Contributions.
152
+
153
+ 6. Trademarks. This License does not grant permission to use the trade
154
+ names, trademarks, service marks, or product names of the Licensor,
155
+ except as required for reasonable and customary use in describing the
156
+ origin of the Work and reproducing the content of the NOTICE file.
157
+
158
+ 7. Disclaimer of Warranty. Unless required by applicable law or
159
+ agreed to in writing, Licensor provides the Work (and each
160
+ Contributor provides its Contributions) on an "AS IS" BASIS,
161
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
162
+ implied, including, without limitation, any warranties or conditions
163
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
164
+ PARTICULAR PURPOSE. You are solely responsible for determining the
165
+ appropriateness of using or redistributing the Work and assume any
166
+ risks associated with Your exercise of permissions under this License.
167
+
168
+ 8. Limitation of Liability. In no event and under no legal theory,
169
+ whether in tort (including negligence), contract, or otherwise,
170
+ unless required by applicable law (such as deliberate and grossly
171
+ negligent acts) or agreed to in writing, shall any Contributor be
172
+ liable to You for damages, including any direct, indirect, special,
173
+ incidental, or consequential damages of any character arising as a
174
+ result of this License or out of the use or inability to use the
175
+ Work (including but not limited to damages for loss of goodwill,
176
+ work stoppage, computer failure or malfunction, or any and all
177
+ other commercial damages or losses), even if such Contributor
178
+ has been advised of the possibility of such damages.
179
+
180
+ 9. Accepting Warranty or Additional Liability. While redistributing
181
+ the Work or Derivative Works thereof, You may choose to offer,
182
+ and charge a fee for, acceptance of support, warranty, indemnity,
183
+ or other liability obligations and/or rights consistent with this
184
+ License. However, in accepting such obligations, You may act only
185
+ on Your own behalf and on Your sole responsibility, not on behalf
186
+ of any other Contributor, and only if You agree to indemnify,
187
+ defend, and hold each Contributor harmless for any liability
188
+ incurred by, or claims asserted against, such Contributor by reason
189
+ of your accepting any such warranty or additional liability.
190
+
191
+ END OF TERMS AND CONDITIONS
192
+
193
+ APPENDIX: How to apply the Apache License to your work.
194
+
195
+ To apply the Apache License to your work, attach the following
196
+ boilerplate notice, with the fields enclosed by brackets "[]"
197
+ replaced with your own identifying information. (Don't include
198
+ the brackets!) The text should be enclosed in the appropriate
199
+ comment syntax for the file format. We also recommend that a
200
+ file or class name and description of purpose be included on the
201
+ same "printed page" as the copyright notice for easier
202
+ identification within third-party archives.
203
+
204
+ Copyright [yyyy] [name of copyright owner]
205
+
206
+ Licensed under the Apache License, Version 2.0 (the "License");
207
+ you may not use this file except in compliance with the License.
208
+ You may obtain a copy of the License at
209
+
210
+ http://www.apache.org/licenses/LICENSE-2.0
211
+
212
+ Unless required by applicable law or agreed to in writing, software
213
+ distributed under the License is distributed on an "AS IS" BASIS,
214
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
215
+ See the License for the specific language governing permissions and
216
+ limitations under the License.
@@ -0,0 +1,124 @@
1
+ Metadata-Version: 2.1
2
+ Name: volttron-core
3
+ Version: 2.0.0rc0
4
+ Summary: VOLTTRON™ is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data.
5
+ Home-page: https://volttron.org
6
+ License: Apache-2.0
7
+ Author: volttron
8
+ Author-email: volttron@pnnl.gov
9
+ Requires-Python: >=3.10,<4.0
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Education
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
+ Requires-Dist: PyYAML (>=6.0,<7.0)
21
+ Requires-Dist: blinker (>=1.7.0,<2.0.0)
22
+ Requires-Dist: cattrs (>=23.2.3,<24.0.0)
23
+ Requires-Dist: cryptography (>=43.0.1,<44.0.0)
24
+ Requires-Dist: dataclass-wizard (>=0.22.3,<0.23.0)
25
+ Requires-Dist: dateutils (>=0.6.12,<0.7.0)
26
+ Requires-Dist: deprecated (>=1.2.14,<2.0.0)
27
+ Requires-Dist: gevent (>=24.2.1,<25.0.0)
28
+ Requires-Dist: pip (>=24.0,<25.0)
29
+ Requires-Dist: poetry (>=1.8.2,<2.0.0)
30
+ Requires-Dist: psutil (>=5.9.0,<6.0.0)
31
+ Requires-Dist: pytest-mock (>=3.10.0,<4.0.0)
32
+ Requires-Dist: pytest-timeout (>=2.1.0,<3.0.0)
33
+ Requires-Dist: pyzmq (>=25.1.2,<26.0.0)
34
+ Requires-Dist: returns (>=0.22.0,<0.23.0)
35
+ Requires-Dist: toml (>=0.10.2,<0.11.0)
36
+ Requires-Dist: tzlocal (>=4.1,<5.0)
37
+ Requires-Dist: watchdog-gevent (>=0.1.1,<0.2.0)
38
+ Project-URL: Documentation, https://volttron.readthedocs.org
39
+ Project-URL: Repository, https://github.com/eclipse-volttron/volttron-core
40
+ Description-Content-Type: text/markdown
41
+
42
+ Eclipse VOLTTRON™ (VOLTTRON/volttron) is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data.
43
+
44
+ [![Eclipse VOLTTRON™](https://img.shields.io/badge/Eclips%20VOLTTRON--red.svg)](https://volttron.readthedocs.io/en/latest/)
45
+ ![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)
46
+ ![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)
47
+ [![Pytests](https://github.com/eclipse-volttron/volttron-core/actions/workflows/run-tests.yml/badge.svg)](https://github.com/eclipse-volttron/volttron-core/actions/workflows/run-tests.yml)
48
+ [![pypi version](https://img.shields.io/pypi/v/volttron.svg)](https://pypi.org/project/volttron/)
49
+ ## Pre-requisites
50
+ git >= 2.25
51
+
52
+ poetry >= 1.2.2
53
+
54
+ python >= 3.10
55
+
56
+ pip >= 24.0
57
+
58
+ Note- Ubuntu 22.04 comes with python 3.10. To upgrade pip run ```python -m pip install --upgrade pip```
59
+
60
+ ## Installation
61
+ This package is the core volttron server, client and utilities. in order to successfully start volttron at a minimum you would need a volttron message bus(volttron-lib-zmq) and volttron authentication library(volttron-lib-auth). You can install these as three separate steps or use the wrapper (volttron-zmq) that pulls all three packages
62
+ It is recommended to use a virtual environment for installing volttron.
63
+
64
+ ```shell
65
+ python -m venv env
66
+ source env/bin/activate
67
+ export VOLTTRON_HOME=</path/to/volttron/home>
68
+ pip install volttron-zmq
69
+ ```
70
+
71
+ Note you can also run ```pip install volttron-core volttron-lib-zmq volttron-lib-auth```
72
+
73
+ ### Quick Start
74
+
75
+ 1. Setup VOLTTRON_HOME environment variable: export VOLTTRON_HOME=/path/to/volttron_home/dir
76
+
77
+ **NOTE** This is madatory if you have/had in the past, a monolithic VOLTTRON version that used the default VOLTTRON_HOME $HOME/.volttron. This modular version of VOLTTRON cannot work with volttron_home used by monolithic version of VOLTTRON(version 8.3 or earlier)
78
+
79
+ 2. Start the platform
80
+ ```bash
81
+ volttron -vv -l volttron.log &>/dev/null &
82
+ ```
83
+
84
+ 3. Install listener agent
85
+ ```bash
86
+ vctl install volttron-listener --start
87
+ ```
88
+
89
+ 4. View status of platform
90
+ ```bash
91
+ vctl status
92
+ ```
93
+
94
+ 5. Shutdown the platform
95
+ ```bash
96
+ vctl shutdown --platform
97
+ ```
98
+
99
+ Full VOLTTRON documentation available at [VOLTTRON Readthedocs](https://volttron.readthedocs.io)
100
+
101
+ ## Contributing to VOLTTRON
102
+
103
+ Please see the [contributing.md](CONTRIBUTING.md) document before contributing to this repository.
104
+
105
+ Please see [developing_on_modular.md](DEVELOPING_ON_MODULAR.md) document for developing your agents against volttron.
106
+
107
+ # Disclaimer Notice
108
+
109
+ This material was prepared as an account of work sponsored by an agency of the
110
+ United States Government. Neither the United States Government nor the United
111
+ States Department of Energy, nor Battelle, nor any of their employees, nor any
112
+ jurisdiction or organization that has cooperated in the development of these
113
+ materials, makes any warranty, express or implied, or assumes any legal
114
+ liability or responsibility for the accuracy, completeness, or usefulness or any
115
+ information, apparatus, product, software, or process disclosed, or represents
116
+ that its use would not infringe privately owned rights.
117
+
118
+ Reference herein to any specific commercial product, process, or service by
119
+ trade name, trademark, manufacturer, or otherwise does not necessarily
120
+ constitute or imply its endorsement, recommendation, or favoring by the United
121
+ States Government or any agency thereof, or Battelle Memorial Institute. The
122
+ views and opinions of authors expressed herein do not necessarily state or
123
+ reflect those of the United States Government or any agency thereof.
124
+
@@ -0,0 +1,82 @@
1
+ Eclipse VOLTTRON™ (VOLTTRON/volttron) is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data.
2
+
3
+ [![Eclipse VOLTTRON™](https://img.shields.io/badge/Eclips%20VOLTTRON--red.svg)](https://volttron.readthedocs.io/en/latest/)
4
+ ![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)
5
+ ![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)
6
+ [![Pytests](https://github.com/eclipse-volttron/volttron-core/actions/workflows/run-tests.yml/badge.svg)](https://github.com/eclipse-volttron/volttron-core/actions/workflows/run-tests.yml)
7
+ [![pypi version](https://img.shields.io/pypi/v/volttron.svg)](https://pypi.org/project/volttron/)
8
+ ## Pre-requisites
9
+ git >= 2.25
10
+
11
+ poetry >= 1.2.2
12
+
13
+ python >= 3.10
14
+
15
+ pip >= 24.0
16
+
17
+ Note- Ubuntu 22.04 comes with python 3.10. To upgrade pip run ```python -m pip install --upgrade pip```
18
+
19
+ ## Installation
20
+ This package is the core volttron server, client and utilities. in order to successfully start volttron at a minimum you would need a volttron message bus(volttron-lib-zmq) and volttron authentication library(volttron-lib-auth). You can install these as three separate steps or use the wrapper (volttron-zmq) that pulls all three packages
21
+ It is recommended to use a virtual environment for installing volttron.
22
+
23
+ ```shell
24
+ python -m venv env
25
+ source env/bin/activate
26
+ export VOLTTRON_HOME=</path/to/volttron/home>
27
+ pip install volttron-zmq
28
+ ```
29
+
30
+ Note you can also run ```pip install volttron-core volttron-lib-zmq volttron-lib-auth```
31
+
32
+ ### Quick Start
33
+
34
+ 1. Setup VOLTTRON_HOME environment variable: export VOLTTRON_HOME=/path/to/volttron_home/dir
35
+
36
+ **NOTE** This is madatory if you have/had in the past, a monolithic VOLTTRON version that used the default VOLTTRON_HOME $HOME/.volttron. This modular version of VOLTTRON cannot work with volttron_home used by monolithic version of VOLTTRON(version 8.3 or earlier)
37
+
38
+ 2. Start the platform
39
+ ```bash
40
+ volttron -vv -l volttron.log &>/dev/null &
41
+ ```
42
+
43
+ 3. Install listener agent
44
+ ```bash
45
+ vctl install volttron-listener --start
46
+ ```
47
+
48
+ 4. View status of platform
49
+ ```bash
50
+ vctl status
51
+ ```
52
+
53
+ 5. Shutdown the platform
54
+ ```bash
55
+ vctl shutdown --platform
56
+ ```
57
+
58
+ Full VOLTTRON documentation available at [VOLTTRON Readthedocs](https://volttron.readthedocs.io)
59
+
60
+ ## Contributing to VOLTTRON
61
+
62
+ Please see the [contributing.md](CONTRIBUTING.md) document before contributing to this repository.
63
+
64
+ Please see [developing_on_modular.md](DEVELOPING_ON_MODULAR.md) document for developing your agents against volttron.
65
+
66
+ # Disclaimer Notice
67
+
68
+ This material was prepared as an account of work sponsored by an agency of the
69
+ United States Government. Neither the United States Government nor the United
70
+ States Department of Energy, nor Battelle, nor any of their employees, nor any
71
+ jurisdiction or organization that has cooperated in the development of these
72
+ materials, makes any warranty, express or implied, or assumes any legal
73
+ liability or responsibility for the accuracy, completeness, or usefulness or any
74
+ information, apparatus, product, software, or process disclosed, or represents
75
+ that its use would not infringe privately owned rights.
76
+
77
+ Reference herein to any specific commercial product, process, or service by
78
+ trade name, trademark, manufacturer, or otherwise does not necessarily
79
+ constitute or imply its endorsement, recommendation, or favoring by the United
80
+ States Government or any agency thereof, or Battelle Memorial Institute. The
81
+ views and opinions of authors expressed herein do not necessarily state or
82
+ reflect those of the United States Government or any agency thereof.
@@ -0,0 +1,83 @@
1
+ [tool.poetry]
2
+ name = "volttron-core"
3
+ version = "2.0.0rc0"
4
+ description = "VOLTTRON™ is an open source platform for distributed sensing and control. The platform provides services for collecting and storing data from buildings and devices and provides an environment for developing applications which interact with that data."
5
+ authors = ["volttron <volttron@pnnl.gov>"]
6
+ license = "Apache-2.0"
7
+ readme = "README.md"
8
+ homepage = "https://volttron.org"
9
+ repository = "https://github.com/eclipse-volttron/volttron-core"
10
+ documentation = "https://volttron.readthedocs.org"
11
+ classifiers = [
12
+ "Development Status :: 3 - Alpha",
13
+ "Intended Audience :: Education",
14
+ "Intended Audience :: Developers",
15
+ "Programming Language :: Python",
16
+ "Programming Language :: Python :: 3.10",
17
+ "Programming Language :: Python :: 3.11",
18
+ "Topic :: Software Development :: Libraries :: Python Modules"
19
+ ]
20
+
21
+ packages = [
22
+ { include = "volttron", from = "src" },
23
+ { include = "volttron/py.typed", from = "src" }
24
+ ]
25
+
26
+ [tool.poetry.dependencies]
27
+ poetry = "^1.8.2"
28
+ python = "^3.10"
29
+ gevent = "^24.2.1"
30
+ PyYAML = "^6.0"
31
+ toml = "^0.10.2"
32
+ dateutils = "^0.6.12"
33
+ tzlocal = "^4.1"
34
+ psutil = "^5.9.0"
35
+ cryptography = "^43.0.1"
36
+ watchdog-gevent = "^0.1.1"
37
+ pip = "^24.0"
38
+ pytest-timeout = "^2.1.0"
39
+ pytest-mock = "^3.10.0"
40
+ deprecated = "^1.2.14"
41
+ blinker = "^1.7.0"
42
+ dataclass-wizard = "^0.22.3"
43
+ returns = "^0.22.0"
44
+ pyzmq = "^25.1.2"
45
+ cattrs = "^23.2.3"
46
+
47
+ [tool.poetry.group.dev.dependencies]
48
+ pytest = "^6.2.5"
49
+ mock = "^4.0.3"
50
+ pre-commit = "^2.17.0"
51
+ yapf = "^0.32.0"
52
+ toml = "^0.10.2"
53
+ mypy = "^1.2.0"
54
+
55
+ [build-system]
56
+ requires = ["poetry-core>=1.2.0"]
57
+ build-backend = "poetry.core.masonry.api"
58
+
59
+ [tool.poetry.scripts]
60
+ volttron = 'volttron.server.__main__:main'
61
+ vcfg = 'volttron.client.commands.config:main'
62
+ volttron-cfg = 'volttron.client.commands.config:main'
63
+ vctl = 'volttron.client.commands.control:main'
64
+ volttron-ctl = 'volttron.client.commands.control:main'
65
+
66
+ [tool.yapfignore]
67
+ ignore_patterns = [
68
+ ".venv/**",
69
+ ".pytest_cache/**",
70
+ "dist/**",
71
+ "docs/**"
72
+ ]
73
+
74
+ [tool.yapf]
75
+ based_on_style = "pep8"
76
+ spaces_before_comment = 4
77
+ column_limit = 120
78
+ split_before_logical_operator = true
79
+
80
+ [tool.mypy]
81
+ show_error_context = true
82
+ pretty = true
83
+ show_column_numbers = true
@@ -0,0 +1,67 @@
1
+ # -*- coding: utf-8 -*- {{{
2
+ # ===----------------------------------------------------------------------===
3
+ #
4
+ # Installable Component of Eclipse VOLTTRON
5
+ #
6
+ # ===----------------------------------------------------------------------===
7
+ #
8
+ # Copyright 2022 Battelle Memorial Institute
9
+ #
10
+ # Licensed under the Apache License, Version 2.0 (the "License"); you may not
11
+ # use this file except in compliance with the License. You may obtain a copy
12
+ # of the License at
13
+ #
14
+ # http://www.apache.org/licenses/LICENSE-2.0
15
+ #
16
+ # Unless required by applicable law or agreed to in writing, software
17
+ # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18
+ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
19
+ # License for the specific language governing permissions and limitations
20
+ # under the License.
21
+ #
22
+ # ===----------------------------------------------------------------------===
23
+ # }}}
24
+ """ Core package."""
25
+ from typing import List
26
+
27
+ from gevent import monkey
28
+
29
+ # At this point these are the only things that need to be patched
30
+ # and the server and client are working harmoniously with this.
31
+ patches = [
32
+ ('ssl', monkey.patch_ssl),
33
+ ('socket', monkey.patch_socket),
34
+ ('os', monkey.patch_os),
35
+ ]
36
+
37
+ # patch modules if necessary. Only if the module hasn't been patched before.
38
+ # this could happen if the server code uses the client (which it does).
39
+ for module, fn in patches:
40
+ if not monkey.is_module_patched(module):
41
+ fn()
42
+
43
+ import logging
44
+ from urllib.parse import urlparse
45
+
46
+ from volttron.client.logs import get_logger
47
+ from volttron.client.vip.agent.core import Core
48
+ from volttron.client.vip.agent.subsystems.auth import Auth
49
+ from volttron.client.vip.agent.subsystems.configstore import ConfigStore
50
+ from volttron.client.vip.agent.subsystems.health import Health
51
+ from volttron.client.vip.agent.subsystems.heartbeat import Heartbeat
52
+ from volttron.client.vip.agent.subsystems.hello import Hello
53
+ from volttron.client.vip.agent.subsystems.peerlist import PeerList
54
+ from volttron.client.vip.agent.subsystems.ping import Ping
55
+ from volttron.client.vip.agent.subsystems.pubsub import PubSub
56
+ from volttron.client.vip.agent.subsystems.query import Query
57
+ from volttron.client.vip.agent.subsystems.rpc import RPC
58
+ from volttron.client.vip.agent import Agent
59
+ from volttron.types import AbstractAgent
60
+ from volttron.client.logs import setup_logging
61
+
62
+ __all__: List[str] = [
63
+ "AbstractAgent", "Core", "RPC", "Hello", "PeerList", "Ping", "PubSub", "Heartbeat", "Health", "ConfigStore", "Auth",
64
+ "Query", "setup_logging"
65
+ ]
66
+
67
+ _log = get_logger()