codecraftai-interop-ext-can 1.2.0__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.
@@ -0,0 +1,204 @@
1
+ # Code Craft AI - Source Available License
2
+ Version 1.0, October 2026
3
+
4
+ Copyright (C) 2026, Code Craft AI LLC
5
+
6
+ Everyone is permitted to copy and distribute verbatim copies of *This License* document, but changing it is not allowed.
7
+
8
+ *This License* covers the Python Automation Kit, the full suite of software published by *Licensor* that consists of every `codecraftai-*` package, every `pychestrate` package, and the `pychestrate` server.
9
+
10
+ *The Software* is source available. Its source code is published so that anyone can read it, learn from it, and use it, but *This License* is not an open source license. *The Software* is free to use for *Non-Commercial Use*. *Commercial Use* is permitted in exchange for a *Usage Fee* that is based on a reasonable estimation of the income derived from *The Software*, as described in section 5. When a company migrates a product or service to *The Software* from another code base, the *Profit* from that product or service is not counted toward the *Usage Fee* for two years, as described in section 5.4. For assurance of costs, a company can disclose its usage and estimated returns to *Licensor* and negotiate a fixed license cost, as described in section 5.10.
11
+
12
+ ## 1. Definitions
13
+
14
+ ### 1.1 *This License* or *The License*
15
+ **This License** or **The License** refers to version 1.0 of the Code Craft AI - Source Available License.
16
+
17
+ ### 1.2 Licensor
18
+ **Licensor** refers to Code Craft AI LLC.
19
+
20
+ ### 1.3 The Software
21
+ **The Software** refers to the Python Automation Kit, the full suite of software that *Licensor* publishes under *This License*. The Python Automation Kit consists of the following components (each, a **Component**), together with their source code, documentation, and other materials:
22
+
23
+ 1. Every Python package published by *Licensor* whose name begins with `codecraftai-`
24
+ 2. Every Python package published by *Licensor* whose name begins with `pychestrate`
25
+ 3. The `pychestrate` server
26
+
27
+ ### 1.4 You
28
+ **You** refers to the individual or legal entity that exercises rights under *This License*. When an individual exercises rights under *This License* on behalf of a company, organization, or other legal entity, **You** refers to that entity.
29
+
30
+ ### 1.5 Use
31
+ **Use** means to install, execute, load, access, operate, display, copy, modify, configure, customize, and otherwise use.
32
+
33
+ ### 1.6 Non-Commercial Use
34
+ **Non-Commercial Use** means any *Use* of *The Software* that is not *Commercial Use*. Examples of *Non-Commercial Use* include personal use, hobby projects, study, teaching, academic research, evaluation, and use by a non-profit organization for its non-profit purposes.
35
+
36
+ ### 1.7 Commercial Use
37
+ **Commercial Use** means any *Use* of *The Software* by or on behalf of a for-profit entity, and any *Use* of *The Software* in connection with a product, service, or activity that generates revenue. *Commercial Use* includes, without limitation, *Use* of *The Software* to develop, build, test, validate, deploy, operate, or support commercial products and services, and *Use* of *The Software* to provide services to others.
38
+
39
+ ### 1.8 Commercial Activity
40
+ **Commercial Activity** means the products, services, and business operations in connection with which *You* make *Commercial Use* of *The Software*.
41
+
42
+ ### 1.9 Fiscal Year
43
+ **Fiscal Year** means the annual accounting period that *You* use for financial reporting.
44
+
45
+ ### 1.10 Profit
46
+ **Profit** means the net profit that *You* earn from the *Commercial Activity* during a *Fiscal Year*, determined under the accounting principles that *You* regularly use for financial reporting.
47
+
48
+ ### 1.11 Contribution Estimate
49
+ **Contribution Estimate** means *Your* reasonable, good faith estimate of the portion of the *Profit* that *The Software* contributed to, expressed as a number from 0 to 1.
50
+
51
+ ### 1.12 Derived Income
52
+ **Derived Income** means the portion of the *Profit* for a *Fiscal Year* that is derived from *The Software*, calculated as described in section 5.2.
53
+
54
+ ### 1.13 Usage Fee
55
+ **Usage Fee** means the yearly fee for *Commercial Use* that is set by the table in section 5.3.
56
+
57
+ ### 1.14 Migration
58
+ **Migration** means moving the work for one of *Your* products or services from a code base other than *The Software*, such as another framework, another library, or *Your* own code, to *The Software*.
59
+
60
+ ### 1.15 Migration Period
61
+ **Migration Period** means the two (2) year period, described in section 5.4, during which the *Profit* from a product or service that *You* are migrating to *The Software* is not counted.
62
+
63
+ ## 2. License Grant
64
+
65
+ Subject to the terms and conditions of *This License*, *Licensor* hereby grants to *You* a non-exclusive, worldwide, non-transferable license to *Use*, copy, modify, create derivative works of, and distribute *The Software*.
66
+
67
+ *Licensor* also grants to *You* a license under any patents that *Licensor* can license, and that are necessarily infringed by *The Software*, for the same purposes and subject to the same conditions as the license granted above.
68
+
69
+ *This License* covers the Python Automation Kit as a whole. *Use* of one, some, or all of the *Components* is *Use* of *The Software*.
70
+
71
+ The licenses granted by *This License* are free of charge for *Non-Commercial Use*. The licenses granted by *This License* for *Commercial Use* are conditioned on the payment of the *Usage Fee* described in section 5.
72
+
73
+ ## 3. Conditions
74
+
75
+ ### 3.1 License Notice
76
+ Every copy of *The Software* that *You* distribute, in original or modified form, must include a complete copy of *This License* and must keep all copyright, patent, trademark, and attribution notices that appear in *The Software*.
77
+
78
+ ### 3.2 Recipients
79
+ Anyone who receives *The Software* from *You* receives it under the terms of *This License*. *You* may not impose terms on a recipient that conflict with *This License*, and *You* may not grant a recipient rights that *This License* does not grant to *You*.
80
+
81
+ ### 3.3 Modified Versions
82
+ *You* must clearly mark any modified version of *The Software* as modified. *The Software* is published by *Licensor* under a specific identity, such as a package name. *You* may not publish a modified version of *The Software* under the identity that *Licensor* originally published it under. Every copy of *The Software* that *You* redistribute under its original identity must be an exact copy of *The Software* as *Licensor* published it.
83
+
84
+ ### 3.4 Trademarks
85
+ *This License* does not grant any rights to use the names, logos, or trademarks of *Licensor*, except as required to comply with section 3.1 and to describe the origin of *The Software*.
86
+
87
+ ## 4. Non-Commercial Use
88
+
89
+ *Non-Commercial Use* of *The Software* is free. No *Usage Fee*, registration, or report is required for *Non-Commercial Use*.
90
+
91
+ ## 5. Commercial Use
92
+
93
+ ### 5.1 Usage Fee Obligation
94
+ For each *Fiscal Year* in which *You* make *Commercial Use* of *The Software*, *You* must pay *Licensor* a *Usage Fee*. A single *Usage Fee* covers all of *Your* *Commercial Use* of the *Components*. *Usage Fees* are not owed separately for each *Component*.
95
+
96
+ ### 5.2 Derived Income
97
+ The *Derived Income* for a *Fiscal Year* is calculated as follows:
98
+
99
+ (Contribution Estimate) * (Profit) = (Derived Income)
100
+
101
+ If *You* make *Commercial Use* of *The Software* for more than one product or service, calculate the *Derived Income* for each product or service using its own *Contribution Estimate* and *Profit*, and add the results together. The *Profit* from a product or service that is in its *Migration Period* is not counted, as described in section 5.4.
102
+
103
+ If the *Profit* from a product or service for a *Fiscal Year* is zero or less, then the *Derived Income* from that product or service for that *Fiscal Year* is zero.
104
+
105
+ ### 5.3 Usage Fee
106
+ The *Usage Fee* for a *Fiscal Year* is set by the *Derived Income* for that *Fiscal Year*, as shown in the following table.
107
+
108
+ | Derived Income for the Fiscal Year | Usage Fee per Fiscal Year |
109
+ |------------------------------------|---------------------------|
110
+ | 1,000,000 or less | Free |
111
+ | More than 1,000,000, up to and including 10,000,000 | 50,000 |
112
+ | More than 10,000,000, up to and including 100,000,000 | 100,000 |
113
+ | More than 100,000,000, up to and including 1,000,000,000 | 250,000 |
114
+ | More than 1,000,000,000 | 500,000 |
115
+
116
+ All amounts in this section 5 are in United States dollars. If *You* report *Profit* in a different currency, convert the *Derived Income* to United States dollars using the average exchange rate for the *Fiscal Year*.
117
+
118
+ ### 5.4 Migration Allowance
119
+ When *You* migrate a product or service to *The Software*, the *Profit* from that product or service is not counted when calculating the *Derived Income* during its *Migration Period* (the **Migration Allowance**).
120
+
121
+ The *Migration Period* for a product or service begins on the date that *You* first make *Commercial Use* of *The Software* for that product or service as part of its *Migration*, and ends two (2) years after that date.
122
+
123
+ The *Migration Allowance* applies to each product or service separately, and *You* may use it for every product or service that *You* migrate. Each product or service has only one *Migration Period*.
124
+
125
+ If a *Fiscal Year* is only partly within the *Migration Period* of a product or service, the *Profit* from that product or service for that *Fiscal Year* is reduced in proportion to the number of days of that *Fiscal Year* that fall within its *Migration Period*.
126
+
127
+ For example, a company tests product A with *The Software* and pays a *Usage Fee* based on the *Profit* from product A. On March 1, 2027, the company begins moving the testing of product B from a different test framework to *The Software*. The company does not count the *Profit* from product B in its *Derived Income* from March 1, 2027 until March 1, 2029. Starting March 1, 2029, the *Profit* from product B is counted. If the company later migrates product C, the *Profit* from product C is not counted for two years from the start of its own *Migration*.
128
+
129
+ ### 5.5 Contribution Estimate
130
+ *You* are responsible for making the *Contribution Estimate*. A *Contribution Estimate* must be reasonable and made in good faith. The *Contribution Estimate* for a product or service covers all of the *Components* that *You* *Use* for that product or service. When making the *Contribution Estimate*, *You* should consider how important *The Software* is to the *Commercial Activity*, how much of the *Commercial Activity* depends on *The Software*, and the effort and cost that *You* would otherwise need to spend to accomplish what *The Software* accomplishes for *You*.
131
+
132
+ The following table is a guide for making the *Contribution Estimate*. When *Your* *Commercial Use* of *The Software* matches an entry in the table, the *Contribution Estimate* in that entry is a reasonable *Contribution Estimate*. When *Your* *Commercial Use* does not match an entry in the table, make the *Contribution Estimate* by comparing *Your* *Commercial Use* with the entries in the table. When more than one entry matches the same *Commercial Activity*, use the entry with the highest *Contribution Estimate*.
133
+
134
+ | Commercial Use of *The Software* | Contribution Estimate |
135
+ |----------------------------------|-----------------------|
136
+ | Quality Assurance (QA) and Continuous Integration (CI): *The Software* is used to test or validate the products or services of the *Commercial Activity*, or to run their build and test pipelines | 0.3 |
137
+ | Products Completely Based on *The Software*: the products or services of the *Commercial Activity* are built completely on *The Software* | 0.5 |
138
+
139
+ ### 5.6 Examples
140
+ A company earns 1,000,000,000 in *Profit* from a product line during a *Fiscal Year*. The company uses *The Software* for the QA and CI of that product line, so the *Contribution Estimate* is 0.3.
141
+
142
+ 0.3 * 1,000,000,000 = 300,000,000
143
+
144
+ The *Derived Income* of 300,000,000 is more than 100,000,000 and not more than 1,000,000,000, so the *Usage Fee* for that *Fiscal Year* is 250,000.
145
+
146
+ A company earns 4,000,000 in *Profit* from a product during a *Fiscal Year*. The product is built completely on *The Software*, so the *Contribution Estimate* is 0.5.
147
+
148
+ 0.5 * 4,000,000 = 2,000,000
149
+
150
+ The *Derived Income* of 2,000,000 is more than 1,000,000 and not more than 10,000,000, so the *Usage Fee* for that *Fiscal Year* is 50,000.
151
+
152
+ A company earns 3,000,000 in *Profit* from a product line during a *Fiscal Year*. The company uses *The Software* for the QA and CI of that product line, so the *Contribution Estimate* is 0.3.
153
+
154
+ 0.3 * 3,000,000 = 900,000
155
+
156
+ The *Derived Income* of 900,000 is 1,000,000 or less, so there is no *Usage Fee* for that *Fiscal Year*.
157
+
158
+ ### 5.7 Reporting and Payment
159
+ Within one hundred twenty (120) days after the end of each *Fiscal Year* for which a *Usage Fee* is owed, *You* must pay the *Usage Fee* to *Licensor* and provide *Licensor* with a written statement that shows the *Profit*, the *Contribution Estimate*, the reasoning used to make the *Contribution Estimate*, the *Derived Income*, and the *Usage Fee*. *Usage Fees* are payable in United States dollars. If any *Profit* is not counted under section 5.4, the statement must also identify each product or service that is in a *Migration Period* and show the dates of its *Migration Period*. No statement is required for a *Fiscal Year* in which no *Usage Fee* is owed.
160
+
161
+ ### 5.8 Records and Review
162
+ *You* must keep records that reasonably support each *Contribution Estimate*, each *Profit* figure, and the dates of any *Migration Period* for at least three (3) years after the end of the *Fiscal Year* that they apply to. No more than once in any twelve (12) month period, *Licensor* may ask in writing for the records that support a statement, and *You* must provide them within sixty (60) days of the request. *Licensor* will treat those records as confidential.
163
+
164
+ ### 5.9 Disputes About the Usage Fee
165
+ If *Licensor* believes that a *Contribution Estimate*, a *Profit* figure, or the dates of a *Migration Period* are not reasonable, *Licensor* will notify *You* in writing and explain why. *You* and *Licensor* will then negotiate in good faith for at least sixty (60) days to agree on a reasonable *Usage Fee*. If *You* and *Licensor* cannot agree, either party may resolve the dispute as described in section 8.
166
+
167
+ ### 5.10 Fixed License Cost
168
+ For assurance of costs, *You* may disclose to *Licensor* how *You* *Use* *The Software* and the returns that *You* estimate *You* will derive from it, and negotiate a fixed license cost with *Licensor*. A fixed license cost, and any other terms that *You* and *Licensor* agree to, must be set out in a writing signed by both *You* and *Licensor* (a **Fixed License Agreement**).
169
+
170
+ While a *Fixed License Agreement* is in effect, the fixed license cost replaces the *Usage Fee* for the *Commercial Use* that the *Fixed License Agreement* covers, and sections 5.7 through 5.9 apply to that *Commercial Use* only as the *Fixed License Agreement* provides. To the extent that a *Fixed License Agreement* conflicts with this section 5, the *Fixed License Agreement* controls.
171
+
172
+ *Licensor* will treat the information that *You* disclose under this section 5.10 as confidential.
173
+
174
+ ## 6. Termination
175
+
176
+ If *You* violate *This License*, the licenses granted to *You* by *This License* end. If *Licensor* notifies *You* in writing of the violation and *You* correct the violation within thirty (30) days of receiving the notice, including by paying any *Usage Fee* that is owed, then the licenses granted to *You* are reinstated. This reinstatement is available to *You* only once. Termination does not release *You* from any *Usage Fee* that is owed for *Commercial Use* that took place before the termination.
177
+
178
+ ## 7. No Warranty and Limitation of Liability
179
+
180
+ ### 7.1 No Warranty
181
+ *THE SOFTWARE* IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
182
+
183
+ ### 7.2 Limitation of Liability
184
+ TO THE EXTENT PERMITTED BY LAW, IN NO EVENT WILL *LICENSOR* BE LIABLE TO *YOU* FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES OF ANY KIND ARISING OUT OF OR RELATED TO *THIS LICENSE* OR THE *USE* OF *THE SOFTWARE*, EVEN IF *LICENSOR* HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
185
+
186
+ ### 7.3 Support
187
+ *This License* does not entitle *You* to support, maintenance, or other services. Support and services are available only under a separate written agreement with *Licensor*.
188
+
189
+ ## 8. Governing Law and Jurisdiction
190
+
191
+ *This License* is governed by the laws of the State of Washington and the United States as though fully performed in Washington, without regard to provisions relating to conflicts of laws. The UN Convention for the International Sale of Goods and the Uniform Computer Information Transactions Act (UCITA) will not apply. The state and federal courts located in King County, Washington will have exclusive jurisdiction to adjudicate any disputes arising under *This License*, and *You* and *Licensor* agree to submit to the jurisdiction of those courts.
192
+
193
+ ## 9. General
194
+
195
+ ### 9.1 Severability
196
+ If any provision of *This License* is held to be unenforceable, that provision will be enforced to the maximum extent permitted, and the remaining provisions of *This License* will remain in effect.
197
+
198
+ ### 9.2 Interpretation
199
+ The section headings in *This License* are for reference purposes only and do not modify or restrict any term of *This License*. *This License* is written in the English language, and the English text prevails over any translation.
200
+
201
+ ### 9.3 Contact
202
+ Questions about *This License*, *Usage Fee* statements, payments, and requests to negotiate a *Fixed License Agreement* may be sent to *Licensor* using the contact information published at:
203
+
204
+ https://code-craft.ai
@@ -0,0 +1,84 @@
1
+ Metadata-Version: 2.4
2
+ Name: codecraftai-interop-ext-can
3
+ Version: 1.2.0
4
+ Summary: Code Craft AI Interop Extension for CAN
5
+ License-Expression: LicenseRef-CodeCraftAI-Source-Available
6
+ License-File: LICENSE.md
7
+ Keywords: python
8
+ Author: Myron Walker
9
+ Author-email: myron.walker@gmail.com
10
+ Requires-Python: >=3.10,<4.0
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: Operating System :: POSIX
13
+ Requires-Dist: codecraftai-interop (<2.0.0)
14
+ Requires-Dist: codecraftai-landscaping (<2.0.0)
15
+ Requires-Dist: python-can (>=4.6.1,<5.0.0)
16
+ Project-URL: Issues, https://github.com/code-craft-ai-company/codecraftai-interop-ext-can/issues
17
+ Project-URL: Repository, https://github.com/code-craft-ai-company/codecraftai-interop-ext-can
18
+ Description-Content-Type: text/x-rst
19
+
20
+ ========================================
21
+ Code Craft AI Interop Extension: CAN
22
+ ========================================
23
+
24
+ The ``codecraftai-interop-ext-can`` package provides CAN-bus protocol interop extensions and landscape extensions that allow for interoperability with CAN-bus devices during automation runs. It plugs into the ``codecraftai-interop`` and ``codecraftai-landscaping`` frameworks through the extension mechanism in ``codecraftai-extension``.
25
+
26
+ Highlights
27
+ ==========
28
+
29
+ - CAN-bus protocol handlers under ``interop/ext/can/``.
30
+ - Landscape extension hooks so CAN-bus devices surface as first-class landscape resources.
31
+ - Composable with other ``codecraftai-interop-ext-*`` packages through the shared extension mechanism.
32
+
33
+ Repository Structure
34
+ ====================
35
+
36
+ - ``development/`` - Runtime environment scripts.
37
+ - ``repository-setup/`` - Repository homing and setup scripts.
38
+ - ``source/packages/`` - Package source code.
39
+ - ``source/testroots/ccai/`` - TestBase test roots.
40
+ - ``userguide/`` - Standards, conventions, and documentation.
41
+
42
+ Environment Setup
43
+ =================
44
+
45
+ When working in a Codex container:
46
+
47
+ .. code-block:: bash
48
+
49
+ ./development/setup-agent-container
50
+
51
+ For local development:
52
+
53
+ .. code-block:: bash
54
+
55
+ ./repository-setup/rehome-repository
56
+ ./development/setup-envrionment
57
+
58
+ Running Tests
59
+ =============
60
+
61
+ Activate the virtual environment:
62
+
63
+ .. code-block:: bash
64
+
65
+ source .venv/bin/activate
66
+
67
+ Run the single-host test suite:
68
+
69
+ .. code-block:: bash
70
+
71
+ testbase testing run --root source/testroots/ccai --includes=ccai.tests.singlehost.interop --output=./.output
72
+
73
+ Standards and Conventions
74
+ =========================
75
+
76
+ - Naming conventions: ``userguide/10-02-naming-conventions.rst``
77
+ - Code organization: ``userguide/10-01-code-organization.rst``
78
+ - Coding standards: ``userguide/10-00-coding-standards.rst``
79
+
80
+ Additional Resources
81
+ ====================
82
+
83
+ - User guide entry point: ``userguide/userguide.rst``
84
+
@@ -0,0 +1,64 @@
1
+ ========================================
2
+ Code Craft AI Interop Extension: CAN
3
+ ========================================
4
+
5
+ The ``codecraftai-interop-ext-can`` package provides CAN-bus protocol interop extensions and landscape extensions that allow for interoperability with CAN-bus devices during automation runs. It plugs into the ``codecraftai-interop`` and ``codecraftai-landscaping`` frameworks through the extension mechanism in ``codecraftai-extension``.
6
+
7
+ Highlights
8
+ ==========
9
+
10
+ - CAN-bus protocol handlers under ``interop/ext/can/``.
11
+ - Landscape extension hooks so CAN-bus devices surface as first-class landscape resources.
12
+ - Composable with other ``codecraftai-interop-ext-*`` packages through the shared extension mechanism.
13
+
14
+ Repository Structure
15
+ ====================
16
+
17
+ - ``development/`` - Runtime environment scripts.
18
+ - ``repository-setup/`` - Repository homing and setup scripts.
19
+ - ``source/packages/`` - Package source code.
20
+ - ``source/testroots/ccai/`` - TestBase test roots.
21
+ - ``userguide/`` - Standards, conventions, and documentation.
22
+
23
+ Environment Setup
24
+ =================
25
+
26
+ When working in a Codex container:
27
+
28
+ .. code-block:: bash
29
+
30
+ ./development/setup-agent-container
31
+
32
+ For local development:
33
+
34
+ .. code-block:: bash
35
+
36
+ ./repository-setup/rehome-repository
37
+ ./development/setup-envrionment
38
+
39
+ Running Tests
40
+ =============
41
+
42
+ Activate the virtual environment:
43
+
44
+ .. code-block:: bash
45
+
46
+ source .venv/bin/activate
47
+
48
+ Run the single-host test suite:
49
+
50
+ .. code-block:: bash
51
+
52
+ testbase testing run --root source/testroots/ccai --includes=ccai.tests.singlehost.interop --output=./.output
53
+
54
+ Standards and Conventions
55
+ =========================
56
+
57
+ - Naming conventions: ``userguide/10-02-naming-conventions.rst``
58
+ - Code organization: ``userguide/10-01-code-organization.rst``
59
+ - Coding standards: ``userguide/10-00-coding-standards.rst``
60
+
61
+ Additional Resources
62
+ ====================
63
+
64
+ - User guide entry point: ``userguide/userguide.rst``
@@ -0,0 +1,60 @@
1
+ [project]
2
+ name = "codecraftai-interop-ext-can"
3
+ version = "1.2.0"
4
+ description = "Code Craft AI Interop Extension for CAN"
5
+ readme = "README.rst"
6
+ license = "LicenseRef-CodeCraftAI-Source-Available"
7
+ authors = [{name = "Myron Walker", email = "myron.walker@gmail.com"}]
8
+ keywords = [
9
+ "python"
10
+ ]
11
+ classifiers = [
12
+ "Programming Language :: Python :: 3",
13
+ "Operating System :: POSIX",
14
+ ]
15
+ requires-python = ">=3.10,<4.0"
16
+ dependencies = [
17
+ "codecraftai-interop<2.0.0",
18
+ "codecraftai-landscaping<2.0.0",
19
+ "python-can>=4.6.1,<5.0.0",
20
+ ]
21
+
22
+ [project.urls]
23
+ Repository = "https://github.com/code-craft-ai-company/codecraftai-interop-ext-can"
24
+ Issues = "https://github.com/code-craft-ai-company/codecraftai-interop-ext-can/issues"
25
+
26
+ [dependency-groups]
27
+ dev = []
28
+
29
+ [tool.poetry]
30
+ packages = [{include="ccai", from="source/packages"}]
31
+
32
+ [tool.poetry.dependencies]
33
+ codecraftai-interop = {source = "codecraftai"}
34
+ codecraftai-landscaping = {source = "codecraftai"}
35
+
36
+ [[tool.poetry.source]]
37
+ name = "codecraftai"
38
+ url = "https://code-craft.ai/licensed-repository/simple/"
39
+ priority = "supplemental"
40
+
41
+ [[tool.uv.index]]
42
+ # Same licensed index as [[tool.poetry.source]]. Listed before PyPI so that
43
+ # codecraftai-* packages (direct and transitive) resolve from it; everything
44
+ # else falls through to PyPI. Credentials: UV_INDEX_CODECRAFTAI_USERNAME /
45
+ # UV_INDEX_CODECRAFTAI_PASSWORD, or `uv auth login`.
46
+ name = "codecraftai"
47
+ url = "https://code-craft.ai/licensed-repository/simple/"
48
+
49
+ [tool.ruff.lint]
50
+ # Deliberately narrow. This gate exists for one reason: a bare `except:`
51
+ # swallows ConfigurationError and SemanticError, which derive from
52
+ # BaseException precisely so that they pass through ordinary handlers and end
53
+ # the run. Catching them hides the original cause behind whatever error
54
+ # happens next. See userguide/10-00-coding-standards.rst, exception-handling
55
+ # rules 5-7. Use `except Exception:` when you mean "any ordinary failure".
56
+ select = ["E722"]
57
+
58
+ [build-system]
59
+ requires = ["poetry-core"]
60
+ build-backend = "poetry.core.masonry.api"
@@ -0,0 +1,12 @@
1
+
2
+ from ccai.interop.ext.can.cancoordinator import CanCoordinator
3
+ from ccai.interop.ext.can.canpresence import CanPresence
4
+ from ccai.interop.ext.can.cansearchwindow import CanSearchWindow
5
+ from ccai.interop.ext.can.candeviceevidence import CanDeviceEvidence
6
+
7
+ __all__ = [
8
+ "CanCoordinator",
9
+ "CanPresence",
10
+ "CanSearchWindow",
11
+ "CanDeviceEvidence",
12
+ ]
@@ -0,0 +1,83 @@
1
+ """
2
+ CAN Coordinator implementation.
3
+ """
4
+ import logging
5
+ from typing import Optional, List, Union
6
+
7
+ import can
8
+
9
+ class CanCoordinator:
10
+ """
11
+ Coordinator for CAN bus interactions.
12
+ """
13
+ def __init__(self, channel: str, bustype: str = 'virtual', bitrate: int = 500000):
14
+ """
15
+ Initializes the CAN Coordinator.
16
+
17
+ :param channel: The CAN interface name (e.g., 'can0', 'vcan0').
18
+ :param bustype: The type of bus (e.g., 'socketcan', 'virtual').
19
+ :param bitrate: The bitrate of the CAN bus.
20
+ """
21
+ self._channel = channel
22
+ self._bustype = bustype
23
+ self._bitrate = bitrate
24
+ self._bus: Optional[can.BusABC] = None
25
+ self._logger = logging.getLogger(__name__)
26
+
27
+ def connect(self):
28
+ """
29
+ Connects to the CAN bus.
30
+
31
+ :raises: can.CanError
32
+ """
33
+ self._logger.info(f"Connecting to CAN bus {self._channel} ({self._bustype})")
34
+ try:
35
+ # python-can 4.2 renamed the 'bustype' keyword to 'interface' and
36
+ # removes 'bustype' in 5.0; pass the value under its current name.
37
+ self._bus = can.Bus(channel=self._channel, interface=self._bustype, bitrate=self._bitrate)
38
+ self._logger.info("Connected to CAN bus")
39
+ except Exception as e:
40
+ self._logger.error(f"Failed to connect to CAN bus: {e}")
41
+ raise
42
+
43
+ def disconnect(self):
44
+ """
45
+ Disconnects from the CAN bus.
46
+ """
47
+ if self._bus:
48
+ self._bus.shutdown()
49
+ self._bus = None
50
+ self._logger.info("Disconnected from CAN bus")
51
+
52
+ def send_message(self, arbitration_id: int, data: Union[List[int], bytes], is_extended_id: bool = False):
53
+ """
54
+ Sends a message on the CAN bus.
55
+
56
+ :param arbitration_id: The ID of the message.
57
+ :param data: The data payload.
58
+ :param is_extended_id: Whether to use extended ID.
59
+ :raises: RuntimeError, can.CanError
60
+ """
61
+ if not self._bus:
62
+ raise RuntimeError("Not connected to CAN bus")
63
+
64
+ msg = can.Message(arbitration_id=arbitration_id, data=data, is_extended_id=is_extended_id)
65
+ try:
66
+ self._bus.send(msg)
67
+ self._logger.debug(f"Sent message: {msg}")
68
+ except can.CanError as e:
69
+ self._logger.error(f"Failed to send message: {e}")
70
+ raise
71
+
72
+ def receive_message(self, timeout: float = 1.0) -> Optional[can.Message]:
73
+ """
74
+ Receives a message from the CAN bus.
75
+
76
+ :param timeout: Time to wait for a message in seconds.
77
+ :return: The received message or None if timeout.
78
+ :raises: RuntimeError
79
+ """
80
+ if not self._bus:
81
+ raise RuntimeError("Not connected to CAN bus")
82
+
83
+ return self._bus.recv(timeout)
@@ -0,0 +1,45 @@
1
+ """
2
+ CAN Device implementation.
3
+ """
4
+ from typing import List, Union, Optional
5
+ from ccai.interop.ext.can.cancoordinator import CanCoordinator
6
+
7
+ class CanDevice:
8
+ """
9
+ Represents a device on the CAN bus.
10
+ """
11
+ def __init__(self, coordinator: CanCoordinator, arbitration_id: int, is_extended_id: Optional[bool] = None):
12
+ """
13
+ Initializes the CAN Device.
14
+
15
+ :param coordinator: The CAN Coordinator instance.
16
+ :param arbitration_id: The arbitration ID of the device (or the ID used to talk to it).
17
+ :param is_extended_id: Whether the ID is an extended ID. If None, it is inferred from arbitration_id > 0x7FF.
18
+ """
19
+ self._coordinator = coordinator
20
+ self._arbitration_id = arbitration_id
21
+ if is_extended_id is None:
22
+ self._is_extended_id = arbitration_id > 0x7FF
23
+ else:
24
+ self._is_extended_id = is_extended_id
25
+
26
+ @property
27
+ def arbitration_id(self) -> int:
28
+ """Returns the arbitration ID."""
29
+ return self._arbitration_id
30
+
31
+ @property
32
+ def is_extended_id(self) -> bool:
33
+ """Returns whether the ID is extended."""
34
+ return self._is_extended_id
35
+
36
+ def send(self, data: Union[List[int], bytes]):
37
+ """
38
+ Sends data to this device.
39
+
40
+ :param data: The data payload.
41
+ """
42
+ self._coordinator.send_message(self._arbitration_id, data, is_extended_id=self._is_extended_id)
43
+
44
+ def __repr__(self):
45
+ return f"CanDevice(id={hex(self._arbitration_id)}, ext={self._is_extended_id})"
@@ -0,0 +1,58 @@
1
+
2
+ """
3
+ .. module:: candeviceevidence
4
+ :platform: Darwin, Linux, Unix, Windows
5
+ :synopsis: Module containing the CanDeviceEvidence object.
6
+
7
+ .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
8
+
9
+ """
10
+
11
+ __author__ = "Myron Walker"
12
+ __copyright__ = "Copyright 2025, Code Craft AI LLC"
13
+ __credits__ = []
14
+
15
+ from typing import Dict, Optional, Any
16
+ from datetime import datetime
17
+
18
+ class CanDeviceEvidence:
19
+ """
20
+ A :class:`CanDeviceEvidence` object is used to track evidence of the current state of CAN devices.
21
+ """
22
+
23
+ def __init__(self, arbitration_id: int, timestamp: Optional[datetime] = None,
24
+ data: Optional[bytes] = None, is_extended_id: bool = False):
25
+ """
26
+ Initialize evidence.
27
+ """
28
+ self._arbitration_id = arbitration_id
29
+ self._timestamp = timestamp if timestamp else datetime.now()
30
+ self._data = data
31
+ self._is_extended_id = is_extended_id
32
+
33
+ @property
34
+ def arbitration_id(self) -> int:
35
+ return self._arbitration_id
36
+
37
+ @property
38
+ def timestamp(self) -> datetime:
39
+ return self._timestamp
40
+
41
+ @property
42
+ def data(self) -> Optional[bytes]:
43
+ return self._data
44
+
45
+ @property
46
+ def is_extended_id(self) -> bool:
47
+ return self._is_extended_id
48
+
49
+ def as_dict(self) -> Dict[str, Any]:
50
+ return {
51
+ "arbitration_id": self._arbitration_id,
52
+ "timestamp": self._timestamp.isoformat(),
53
+ "data": self._data.hex() if self._data else None,
54
+ "is_extended_id": self._is_extended_id
55
+ }
56
+
57
+ def __str__(self):
58
+ return f"<CanDeviceEvidence id={hex(self._arbitration_id)} ext={self._is_extended_id}>"
@@ -0,0 +1,137 @@
1
+
2
+ """
3
+ CAN Presence implementation.
4
+ """
5
+ import logging
6
+ import time
7
+ import threading
8
+ import uuid
9
+ import weakref
10
+ from typing import List, Set, Dict
11
+ from datetime import datetime, timedelta
12
+
13
+ from ccai.interop.ext.can.cancoordinator import CanCoordinator
14
+ from ccai.interop.ext.can.cansearchwindow import CanSearchWindow
15
+ from ccai.interop.ext.can.candeviceevidence import CanDeviceEvidence
16
+
17
+ class CanPresence:
18
+ """
19
+ Handles presence detection on the CAN bus using a background monitoring thread.
20
+ """
21
+ def __init__(self, coordinator: CanCoordinator):
22
+ """
23
+ Initializes the CAN Presence detector.
24
+
25
+ :param coordinator: The CAN Coordinator instance.
26
+ """
27
+ self._coordinator = coordinator
28
+ self._logger = logging.getLogger(__name__)
29
+
30
+ self._lock = threading.Lock()
31
+ self._running = False
32
+ self._monitor_thread = None
33
+
34
+ self._detected_ids: Set[int] = set()
35
+ self._active_devices: Dict[int, CanDeviceEvidence] = {}
36
+
37
+ self._search_windows: Dict[str, weakref.ref] = {}
38
+
39
+
40
+ def start(self):
41
+ """
42
+ Starts the CAN bus monitoring thread.
43
+ """
44
+ with self._lock:
45
+ if self._running:
46
+ return
47
+
48
+ self._running = True
49
+
50
+ # Start background thread
51
+ self._monitor_thread = threading.Thread(target=self._monitor_loop, daemon=True, name="am-can-presence-mon")
52
+ self._monitor_thread.start()
53
+
54
+ self._logger.info("CAN Presence monitoring started.")
55
+
56
+ def stop(self):
57
+ """
58
+ Stops the CAN bus monitoring thread.
59
+ """
60
+ with self._lock:
61
+ if not self._running:
62
+ return
63
+ self._running = False
64
+
65
+ # Join thread? Or just let it die as daemon?
66
+ # Ideally join but we won't block here.
67
+ self._logger.info("CAN Presence monitoring stopped.")
68
+
69
+ def discover_devices(self, limit_to: List[int]=None, window_length: float = 2.0,
70
+ monitor_interval: float = 0.5) -> CanSearchWindow:
71
+ """
72
+ Opens a search window for devices.
73
+ Returns a CanSearchWindow.
74
+ """
75
+ if not self._running:
76
+ raise RuntimeError("CanPresence must be running. Call start().")
77
+
78
+ start = datetime.now()
79
+ end = start + timedelta(seconds=window_length)
80
+ wid = str(uuid.uuid4())
81
+
82
+ window = CanSearchWindow(self, wid, start, end, monitor_interval, limit_to=limit_to)
83
+
84
+ with self._lock:
85
+ self._search_windows[wid] = weakref.ref(window)
86
+
87
+ window.start()
88
+ return window
89
+
90
+ def _monitor_loop(self):
91
+ """
92
+ Background loop to read CAN messages.
93
+ """
94
+ while True:
95
+ with self._lock:
96
+ if not self._running:
97
+ break
98
+
99
+ # Read message with short timeout
100
+ try:
101
+ msg = self._coordinator.receive_message(timeout=0.1)
102
+
103
+ if msg:
104
+ timestamp = getattr(msg, 'timestamp', None)
105
+ if timestamp:
106
+ timestamp = datetime.fromtimestamp(timestamp)
107
+ else:
108
+ timestamp = datetime.now()
109
+
110
+ arbitration_id = msg.arbitration_id
111
+ data = getattr(msg, 'data', None)
112
+ is_extended = getattr(msg, 'is_extended_id', False)
113
+
114
+ evidence = CanDeviceEvidence(arbitration_id, timestamp, data, is_extended)
115
+
116
+ with self._lock:
117
+ self._detected_ids.add(arbitration_id)
118
+ self._active_devices[arbitration_id] = evidence
119
+
120
+ # Notify windows
121
+ to_remove = []
122
+ for wid, wref in self._search_windows.items():
123
+ window = wref()
124
+ if window:
125
+ if window.is_active():
126
+ window.add_evidence(evidence)
127
+ else:
128
+ to_remove.append(wid)
129
+
130
+ for wid in to_remove:
131
+ del self._search_windows[wid]
132
+
133
+ except Exception as e:
134
+ self._logger.error(f"Error in CAN monitor loop: {e}")
135
+ time.sleep(1) # Prevent tight loop on repeated error
136
+
137
+ return
@@ -0,0 +1,231 @@
1
+
2
+ """
3
+ .. module:: cansearchwindow
4
+ :platform: Darwin, Linux, Unix, Windows
5
+ :synopsis: cansearchwindow module.
6
+
7
+ .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
8
+ """
9
+
10
+ __author__ = "Myron Walker"
11
+ __copyright__ = "Copyright 2025, Code Craft AI LLC"
12
+ __credits__ = []
13
+
14
+
15
+ from typing import Dict, List, Optional, TYPE_CHECKING
16
+ import threading
17
+ import time
18
+ import weakref
19
+ from datetime import datetime
20
+ from ccai.interop.ext.can.candeviceevidence import CanDeviceEvidence
21
+
22
+ if TYPE_CHECKING:
23
+ from ccai.interop.ext.can.canpresence import CanPresence
24
+
25
+
26
+ class CanSearchWindowState:
27
+ """
28
+ Enumeration describing the lifecycle of a CAN search window.
29
+ """
30
+ INACTIVE = 0
31
+ ACTIVE = 1
32
+ COMPLETED = 2
33
+ TIMEOUT = 3
34
+
35
+
36
+ class CanSearchWindow:
37
+ """
38
+ The CanSearchWindow class provides a synchronization and state managment device for synchronizing the state of CAN search
39
+ activities.
40
+ """
41
+
42
+ def __init__(self, presence: "CanPresence", id: str, start: datetime, end: datetime, monitor_interval: float, limit_to: List[int]=None):
43
+ """
44
+ :param presence: The owning :class:`CanPresence` instance.
45
+ :param id: Identifier for this search window.
46
+ :param start: Start time of the search window.
47
+ :param end: End time of the search window.
48
+ :param monitor_interval: Polling interval for window monitoring.
49
+ :param limit_to: Optional list of arbitration IDs to limit the search.
50
+ """
51
+
52
+ self._presence_ref = weakref.ref(presence)
53
+ self._id = id
54
+ self._start = start
55
+ self._end = end
56
+ self._monitor_interval = monitor_interval
57
+ self._limit_to = limit_to
58
+
59
+ self._still_waiting_for = None
60
+ if limit_to is not None:
61
+ self._still_waiting_for = [hint for hint in limit_to]
62
+
63
+ self._window_state = CanSearchWindowState.INACTIVE
64
+
65
+ self._lock = threading.Lock()
66
+ self._wait_gate = threading.Event()
67
+ self._monitor_thread = None
68
+
69
+ self._devices_found = {} # Map ID (int) -> CanDeviceEvidence
70
+ self._matching_devices = {}
71
+
72
+ return
73
+
74
+ @property
75
+ def devices_found(self) -> Dict[int, CanDeviceEvidence]:
76
+ """
77
+ The dictionary of devices found during the search window.
78
+ :returns: Copy of the devices found mapping.
79
+ """
80
+ with self._lock:
81
+ rtnval = self._devices_found.copy()
82
+ return rtnval
83
+
84
+ @property
85
+ def id(self) -> str:
86
+ """
87
+ The ID of the search window.
88
+ """
89
+ return self._id
90
+
91
+ @property
92
+ def matching_devices(self) -> Dict[int, CanDeviceEvidence]:
93
+ """
94
+ The dictionary of devices that matched the search window criteria.
95
+ """
96
+ with self._lock:
97
+ rtnval = self._matching_devices.copy()
98
+ return rtnval
99
+
100
+ @property
101
+ def presence(self) -> Optional["CanPresence"]:
102
+ """
103
+ The :class:`CanPresence` object that is associated with this search window.
104
+ Returns None if the presence object has been garbage collected.
105
+ """
106
+ return self._presence_ref()
107
+
108
+
109
+ def add_evidence(self, evidence: CanDeviceEvidence):
110
+ """
111
+ Add evidence to the list of devices found during the search window.
112
+ """
113
+
114
+ with self._lock:
115
+ self._devices_found[evidence.arbitration_id] = evidence
116
+
117
+ return
118
+
119
+
120
+ def is_active(self) -> bool:
121
+ """
122
+ Check if the search window is active.
123
+ """
124
+
125
+ with self._lock:
126
+ return self._window_state == CanSearchWindowState.ACTIVE
127
+
128
+
129
+ def start(self):
130
+ """
131
+ Begin monitoring for search results in a background thread.
132
+ """
133
+ self._lock.acquire()
134
+ try:
135
+ start_gate = threading.Event()
136
+ start_gate.clear()
137
+
138
+ self._monitor_thread = threading.Thread(target=self._monitor_thread_entry, name="am-can-search-window-mon", args=(start_gate,), daemon=True)
139
+ self._monitor_thread.start()
140
+ finally:
141
+ self._lock.release()
142
+
143
+ start_gate.wait()
144
+
145
+ return
146
+
147
+
148
+ def wait(self, timeout: float = None) -> bool:
149
+ """
150
+ Wait for the search window to close.
151
+
152
+ :param timeout: The time in seconds to wait for the search window to close. If None, then wait indefinitely.
153
+
154
+ :returns: ``True`` if the window closed before timeout, otherwise ``False``.
155
+ """
156
+
157
+ # Check initial state
158
+ with self._lock:
159
+ if self._window_state == CanSearchWindowState.INACTIVE:
160
+ raise RuntimeError("The search window is not active.")
161
+
162
+ if self._window_state != CanSearchWindowState.ACTIVE:
163
+ # Window is already completed or timed out
164
+ return True
165
+
166
+ # Wait for completion without holding the lock
167
+ completed_successfully = self._wait_gate.wait(timeout=timeout)
168
+
169
+ return completed_successfully
170
+
171
+
172
+ def _monitor_thread_entry(self, sgate: threading.Event):
173
+ """
174
+ The monitor thread entry point.
175
+ """
176
+
177
+ with self._lock:
178
+ self._window_state = CanSearchWindowState.ACTIVE
179
+ self._wait_gate.clear()
180
+
181
+ sgate.set()
182
+
183
+ while True:
184
+ with self._lock:
185
+ if self._window_state != CanSearchWindowState.ACTIVE:
186
+ break
187
+
188
+ now = datetime.now()
189
+
190
+ if now > self._end:
191
+ with self._lock:
192
+ self._window_state = CanSearchWindowState.TIMEOUT
193
+ break
194
+
195
+ # Get current state atomically
196
+ with self._lock:
197
+ if self._still_waiting_for is not None:
198
+ checking_for = [hint for hint in self._still_waiting_for]
199
+ current_found = self._devices_found.copy()
200
+ else:
201
+ checking_for = None
202
+ current_found = {}
203
+
204
+ # Process hints
205
+ if checking_for is not None:
206
+ matched_hints = []
207
+ matched_devices = {}
208
+
209
+ for nxt_id_hint in checking_for:
210
+ if nxt_id_hint in current_found:
211
+ matched_hints.append(nxt_id_hint)
212
+ matched_devices[nxt_id_hint] = current_found[nxt_id_hint]
213
+
214
+ # Update shared state atomically
215
+ with self._lock:
216
+ if self._still_waiting_for is not None:
217
+ for matched_hint in matched_hints:
218
+ if matched_hint in self._still_waiting_for:
219
+ self._still_waiting_for.remove(matched_hint)
220
+
221
+ self._matching_devices.update(matched_devices)
222
+
223
+ if self._still_waiting_for is not None and len(self._still_waiting_for) == 0:
224
+ self._window_state = CanSearchWindowState.COMPLETED
225
+ break
226
+
227
+ time.sleep(self._monitor_interval)
228
+
229
+ self._wait_gate.set()
230
+
231
+ return