bollard-sdk 0.1.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.
- bollard_sdk-0.1.0/LICENSE +202 -0
- bollard_sdk-0.1.0/NOTICE +11 -0
- bollard_sdk-0.1.0/PKG-INFO +166 -0
- bollard_sdk-0.1.0/README.md +152 -0
- bollard_sdk-0.1.0/pyproject.toml +26 -0
- bollard_sdk-0.1.0/python/bollard_sdk.egg-info/PKG-INFO +166 -0
- bollard_sdk-0.1.0/python/bollard_sdk.egg-info/SOURCES.txt +54 -0
- bollard_sdk-0.1.0/python/bollard_sdk.egg-info/dependency_links.txt +1 -0
- bollard_sdk-0.1.0/python/bollard_sdk.egg-info/top_level.txt +1 -0
- bollard_sdk-0.1.0/python/bollardeck/__init__.py +24 -0
- bollard_sdk-0.1.0/python/bollardeck/_schemas.py +405 -0
- bollard_sdk-0.1.0/python/bollardeck/_version.py +16 -0
- bollard_sdk-0.1.0/python/bollardeck/constants.py +66 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/__init__.py +209 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/_ed25519.py +97 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/attest.py +402 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/discovery.py +164 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/gate.py +385 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/hub.py +785 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/licence.py +204 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/model.py +593 -0
- bollard_sdk-0.1.0/python/bollardeck/corpus/origin.py +213 -0
- bollard_sdk-0.1.0/python/bollardeck/deck/__init__.py +5 -0
- bollard_sdk-0.1.0/python/bollardeck/device/__init__.py +53 -0
- bollard_sdk-0.1.0/python/bollardeck/device/_makers.py +28 -0
- bollard_sdk-0.1.0/python/bollardeck/device/cues.py +343 -0
- bollard_sdk-0.1.0/python/bollardeck/device/dock.py +33 -0
- bollard_sdk-0.1.0/python/bollardeck/device/gestures.py +452 -0
- bollard_sdk-0.1.0/python/bollardeck/device/hal/__init__.py +278 -0
- bollard_sdk-0.1.0/python/bollardeck/device/hal/base.py +179 -0
- bollard_sdk-0.1.0/python/bollardeck/device/hal/detection.py +70 -0
- bollard_sdk-0.1.0/python/bollardeck/device/hal/sim.py +185 -0
- bollard_sdk-0.1.0/python/bollardeck/device/identity.py +330 -0
- bollard_sdk-0.1.0/python/bollardeck/device/keymap.py +153 -0
- bollard_sdk-0.1.0/python/bollardeck/matrix.py +1841 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/__init__.py +100 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/__main__.py +5 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/errors.py +11 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/manifest.py +72 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/runner.py +786 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/sim.py +179 -0
- bollard_sdk-0.1.0/python/bollardeck/routines/yamlsubset.py +447 -0
- bollard_sdk-0.1.0/python/bollardeck/schema.py +340 -0
- bollard_sdk-0.1.0/python/bollardeck/snipler/__init__.py +5 -0
- bollard_sdk-0.1.0/setup.cfg +4 -0
- bollard_sdk-0.1.0/tests/test_corpus_attest.py +415 -0
- bollard_sdk-0.1.0/tests/test_corpus_gate.py +486 -0
- bollard_sdk-0.1.0/tests/test_corpus_hub.py +1035 -0
- bollard_sdk-0.1.0/tests/test_corpus_reality.py +55 -0
- bollard_sdk-0.1.0/tests/test_device.py +900 -0
- bollard_sdk-0.1.0/tests/test_js.py +210 -0
- bollard_sdk-0.1.0/tests/test_matrix.py +251 -0
- bollard_sdk-0.1.0/tests/test_reality.py +109 -0
- bollard_sdk-0.1.0/tests/test_routines.py +619 -0
- bollard_sdk-0.1.0/tests/test_schemas.py +256 -0
- bollard_sdk-0.1.0/tests/test_skeleton.py +124 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
bollard_sdk-0.1.0/NOTICE
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Bollawax Bollard SDK
|
|
2
|
+
Copyright 2026 Graham Smith ("Pop Boll")
|
|
3
|
+
|
|
4
|
+
Code in this repository is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
5
|
+
|
|
6
|
+
The specification pages under spec/ are "Pop Boll, by Graham Smith, CC BY 4.0"
|
|
7
|
+
(see LICENSES/CC-BY-4.0.txt): unchanged copies of the pages published at
|
|
8
|
+
https://popboll.com/spec, with their checksums in spec/SOURCES.json.
|
|
9
|
+
|
|
10
|
+
Bollawax, Bollard, Bolltridge, Pop Boll and Glass Snipler are names of Pop Boll. The licences
|
|
11
|
+
above do not grant trademark rights; see https://popboll.com/trademarks.
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: bollard-sdk
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: The Bollawax Bollard SDK: build on the Pop Boll platform
|
|
5
|
+
Author: Graham Smith (Pop Boll)
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://popboll.com/sdk
|
|
8
|
+
Project-URL: Specification, https://popboll.com/spec
|
|
9
|
+
Requires-Python: >=3.11
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
License-File: NOTICE
|
|
13
|
+
Dynamic: license-file
|
|
14
|
+
|
|
15
|
+
# Bollawax Bollard SDK
|
|
16
|
+
|
|
17
|
+
The SDK for building on the Pop Boll platform: docks, routines, apps and tools that talk to a
|
|
18
|
+
Bollawax device or to its web twin, and that read corpora the way the platform does, respecting
|
|
19
|
+
each corpus's licence and settings.
|
|
20
|
+
|
|
21
|
+
**Status: 0.1.0, the first version, shipped with Bollawax 0.2.4. Its interfaces may still change
|
|
22
|
+
between 0.x versions.** The corpus client, the device layer, routines, the matrix engine and the
|
|
23
|
+
browser binding are built; the dock protocol, the deck client and the Glass Snipler types are
|
|
24
|
+
placeholders. Of the specifications under `spec/`, the software pages are current with this
|
|
25
|
+
version and the hardware pages are speculative drafts: `bollard.md` is version 1, the interface
|
|
26
|
+
under the Boll's foot, and the specification for the cart and its docks is not written
|
|
27
|
+
(`spec/bollardeck.md` §20 records what is decided).
|
|
28
|
+
|
|
29
|
+
Pop Boll builds its own device images and web apps on this SDK. What you install is what we run.
|
|
30
|
+
|
|
31
|
+
## Layout
|
|
32
|
+
|
|
33
|
+
| Path | What | Licence |
|
|
34
|
+
| :--- | :--- | :--- |
|
|
35
|
+
| `python/bollardeck/` | The Python package (`import bollardeck`), standard library only: `corpus` (read corpora through one gate that respects their licence and settings), `device` (hardware abstraction with a simulator and a registry for boards, button cues, gestures, the keymap, device identity), `routines` (the routine API), `matrix` (the LED matrix frame engine: film shots, playback, DJ mode, text, the premiere box), `schema` (validate a document against a format), `constants`. `deck` and `snipler` are placeholders | Apache-2.0 |
|
|
36
|
+
| `js/` | The browser and Node binding, no build step: `bollardeck.js` and its parts (constants, the same validator and schemas, button cues, the LED matrix frame engine, optional page helpers). `js/README.md` is the reference | Apache-2.0 |
|
|
37
|
+
| `c/` | A header for dock firmware | Apache-2.0 |
|
|
38
|
+
| `schema/` | JSON Schemas (draft 2020-12) for eleven formats: corpus manifest, licence block, corpus origin file, routine manifest, button cues, keymap, device identity, maker registry, image release record, Glass Snipler events and frame | Apache-2.0 |
|
|
39
|
+
| `constants/` | `constants.json`, the single source for values Python and JS share (tap timings, cue states, roles, periods and levels, buttons, gesture names, the keymap), and `makers.json`, the maker registry | Apache-2.0 |
|
|
40
|
+
| `conformance/` | Test vectors any implementation must pass, as plain JSON: 203 schema vectors with an index, and behaviour vectors for the corpus gate, gestures, the keymap, cues, the matrix engine and the routine manifest reader | Apache-2.0 |
|
|
41
|
+
| `tools/` | `generate.py` (writes everything derived from `constants/` and `schema/`, for Python and JS; `--check` fails when any is stale), `pin_vectors.py` (writes the expected values of the cue and matrix vectors from the SDK's own Python), `sync_spec.py`, `release.sh` | Apache-2.0 |
|
|
42
|
+
| `examples/` | A device on the simulator with routines, three example routines, a corpus read from a fake hub, a page that runs from disk | Apache-2.0 |
|
|
43
|
+
| `tests/` | The Python suite (`python3 -m unittest discover -s tests`) and the Node tests under `tests/js/` | Apache-2.0 |
|
|
44
|
+
| `spec/` | The public specification pages, unchanged copies of those published at popboll.com/spec (`spec/SOURCES.json` has the checksums) | CC BY 4.0 |
|
|
45
|
+
|
|
46
|
+
## Install (from a checkout)
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pip install .
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```python
|
|
53
|
+
import bollardeck
|
|
54
|
+
print(bollardeck.__version__, bollardeck.SPEAKS)
|
|
55
|
+
|
|
56
|
+
import bollardeck.schema as schema
|
|
57
|
+
print(schema.validate("licence", {"scope": "morpus_only", "store_audio": True}))
|
|
58
|
+
# [Problem(pointer='/store_audio', message='must be false, not true', keyword='const')]
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Corpora
|
|
62
|
+
|
|
63
|
+
```python
|
|
64
|
+
from bollardeck.corpus import HubClient, discover
|
|
65
|
+
|
|
66
|
+
found = discover(roots=["/media/sd/corpora"], hub=HubClient("https://hub.example", token=TOKEN))
|
|
67
|
+
for corpus in found.corpora:
|
|
68
|
+
verdict = corpus.may("study") # the gate: never raises, always says why
|
|
69
|
+
if verdict:
|
|
70
|
+
pairs = corpus.study_pairs(verdict) # content takes the verdict; there is no other way in
|
|
71
|
+
else:
|
|
72
|
+
print(corpus.id, verdict.reason, verdict.detail)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
`help(bollardeck.corpus)` is the usage guide; `examples/corpus_from_a_fake_hub.py` runs without a
|
|
76
|
+
network. The gate's behaviour is pinned by `conformance/corpus-gate/`.
|
|
77
|
+
|
|
78
|
+
A hub's read token alone is study only for a corpus that is not public. To reach such a corpus's
|
|
79
|
+
tracks, audio, art and bundles, say who the client acts for: `HubClient(..., acting_for="ada@example.org")`
|
|
80
|
+
or `hub.corpus(id, acting_for=...)`. The name goes in the `X-Pop-For` header, never in a URL, and
|
|
81
|
+
is self-declared until sign-in arrives. Also there: `CorpusUnavailable` and `NotAvailable` carry a
|
|
82
|
+
`reason` and the hub's `status`; `corpus.open_audio_ranged(file, verdict, range_header=...)` gives
|
|
83
|
+
a relay the source's status and headers; `hub.listing().from_cache`; `corpus.manifest_view()` (read-only,
|
|
84
|
+
no copy); `hub.corpus_gate()` (the hub's rollout switch, `enforce` or `report`). A clock that is set
|
|
85
|
+
back does not reopen an expired licence held in a cache.
|
|
86
|
+
|
|
87
|
+
## The device layer and routines
|
|
88
|
+
|
|
89
|
+
`bollardeck.device` is the hardware abstraction (with a registry so a board family registers
|
|
90
|
+
itself from outside), button cues, the gesture engine, the keymap resolver and device identity;
|
|
91
|
+
`bollardeck.routines` is the routine API. Each module's docstring is its usage guide. To see them
|
|
92
|
+
work together on the simulator:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
python3 examples/device_on_sim.py
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
A key source may say when a press begins (`"<button> down [t_ms]"`, `hal.base.key_line(1, down=True)`).
|
|
99
|
+
That is a hint and never a gesture: a press is a tap or a hold by the `hold_ms` its release
|
|
100
|
+
states, and every `Gesture` carries that `hold_ms`. A `routine.yaml` may also be one JSON object.
|
|
101
|
+
|
|
102
|
+
`bollardeck.matrix` makes the frames of the 13 x 8 LED matrix and its three RGB LEDs, byte for
|
|
103
|
+
byte what `js/bollardeck.matrix.js` makes (`conformance/matrix/`, 1,135 vectors):
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
from bollardeck import matrix
|
|
107
|
+
frame = matrix.glyph("boot", 0) # also film, playback, idle, corpus, dj, text, premiere, tone
|
|
108
|
+
frame.to_bytes(), frame.hex(), matrix.to_ascii(frame)
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
The keymap (`bollardeck.constants.KEYMAP`, `schema/keymap.schema.json`) says what each button
|
|
112
|
+
gesture means, and `conformance/gestures/`, `conformance/cues/` and `conformance/cue-render/` pin
|
|
113
|
+
the behaviour for every binding. `conformance/DECISIONS.md` says what the SDK does where the
|
|
114
|
+
schemas and the pages left room.
|
|
115
|
+
|
|
116
|
+
## Working on it
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
python3 -m unittest discover -s tests # also runs the Node tests when node is installed
|
|
120
|
+
node --test tests/js/*.test.js # the browser binding alone
|
|
121
|
+
python3 tools/generate.py # after changing constants/ or schema/
|
|
122
|
+
python3 tools/pin_vectors.py # after changing how a cue or a matrix frame is drawn
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
`jsonschema` and PyYAML, when installed, cross-check the SDK's own validator and its reader for
|
|
126
|
+
`routine.yaml`. Neither is needed to use the SDK; CI installs both for the tests.
|
|
127
|
+
|
|
128
|
+
**popbollard** is Pop Boll's own repository for Bollawax, and it is closed. Where a tool or a test
|
|
129
|
+
here names it (`tools/sync_spec.py --from`, the `BOLLARD_SDK_POPBOLLARD` environment variable of
|
|
130
|
+
`tests/test_reality.py` and `tests/test_corpus_reality.py`), that is a check for its maintainers:
|
|
131
|
+
it reads a checkout of that repository and is skipped without one. Nothing in the SDK needs it.
|
|
132
|
+
|
|
133
|
+
## In a page
|
|
134
|
+
|
|
135
|
+
```html
|
|
136
|
+
<script src="js/bollardeck.js"></script>
|
|
137
|
+
<script>
|
|
138
|
+
bollardeck.schema.validate("licence", {scope: "morpus_only", store_audio: true});
|
|
139
|
+
bollardeck.cues.at([{button: 1, state: "pulse", role: "go"}], performance.now());
|
|
140
|
+
bollardeck.matrix.glyph("boot", 0);
|
|
141
|
+
</script>
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
One tag loads the whole binding: the validator (the twin of `bollardeck.schema` in Python), the
|
|
145
|
+
button cue helpers, the LED matrix frame engine, the gesture engine and keymap resolver, and the
|
|
146
|
+
corpus gate with a hub client on `fetch`, with optional helpers for elements and a canvas. `js/README.md` is the reference, `examples/browser/index.html` runs from disk, and
|
|
147
|
+
`node --test tests/js/*.test.js` runs its tests. `conformance/matrix/` and
|
|
148
|
+
`conformance/cue-render/` hold the behaviour vectors it must pass (`tools/pin_vectors.py` writes
|
|
149
|
+
their expected values), and `tools/generate.py` writes `js/bollardeck.schemas.js`.
|
|
150
|
+
|
|
151
|
+
`CHANGELOG.md` lists what each version added and changed.
|
|
152
|
+
|
|
153
|
+
## Versions
|
|
154
|
+
|
|
155
|
+
The SDK has its own version (`sdk-v<version>` tags). It is not the Bollawax image version.
|
|
156
|
+
`bollardeck.SPEAKS` lists the wire and format versions this SDK speaks, and
|
|
157
|
+
`bollardeck.MIN_BOLLAWAX` is the oldest Bollawax release it is tested against.
|
|
158
|
+
|
|
159
|
+
## Contributing
|
|
160
|
+
|
|
161
|
+
Pull requests are closed for now; see [CONTRIBUTING.md](CONTRIBUTING.md). Issues are welcome.
|
|
162
|
+
|
|
163
|
+
## Licence
|
|
164
|
+
|
|
165
|
+
Code: Apache-2.0 (`LICENSE`). Specification text in `spec/`: CC BY 4.0, "Pop Boll, by Graham
|
|
166
|
+
Smith" (`LICENSES/CC-BY-4.0.txt`). See `NOTICE` for names and trademarks.
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Bollawax Bollard SDK
|
|
2
|
+
|
|
3
|
+
The SDK for building on the Pop Boll platform: docks, routines, apps and tools that talk to a
|
|
4
|
+
Bollawax device or to its web twin, and that read corpora the way the platform does, respecting
|
|
5
|
+
each corpus's licence and settings.
|
|
6
|
+
|
|
7
|
+
**Status: 0.1.0, the first version, shipped with Bollawax 0.2.4. Its interfaces may still change
|
|
8
|
+
between 0.x versions.** The corpus client, the device layer, routines, the matrix engine and the
|
|
9
|
+
browser binding are built; the dock protocol, the deck client and the Glass Snipler types are
|
|
10
|
+
placeholders. Of the specifications under `spec/`, the software pages are current with this
|
|
11
|
+
version and the hardware pages are speculative drafts: `bollard.md` is version 1, the interface
|
|
12
|
+
under the Boll's foot, and the specification for the cart and its docks is not written
|
|
13
|
+
(`spec/bollardeck.md` §20 records what is decided).
|
|
14
|
+
|
|
15
|
+
Pop Boll builds its own device images and web apps on this SDK. What you install is what we run.
|
|
16
|
+
|
|
17
|
+
## Layout
|
|
18
|
+
|
|
19
|
+
| Path | What | Licence |
|
|
20
|
+
| :--- | :--- | :--- |
|
|
21
|
+
| `python/bollardeck/` | The Python package (`import bollardeck`), standard library only: `corpus` (read corpora through one gate that respects their licence and settings), `device` (hardware abstraction with a simulator and a registry for boards, button cues, gestures, the keymap, device identity), `routines` (the routine API), `matrix` (the LED matrix frame engine: film shots, playback, DJ mode, text, the premiere box), `schema` (validate a document against a format), `constants`. `deck` and `snipler` are placeholders | Apache-2.0 |
|
|
22
|
+
| `js/` | The browser and Node binding, no build step: `bollardeck.js` and its parts (constants, the same validator and schemas, button cues, the LED matrix frame engine, optional page helpers). `js/README.md` is the reference | Apache-2.0 |
|
|
23
|
+
| `c/` | A header for dock firmware | Apache-2.0 |
|
|
24
|
+
| `schema/` | JSON Schemas (draft 2020-12) for eleven formats: corpus manifest, licence block, corpus origin file, routine manifest, button cues, keymap, device identity, maker registry, image release record, Glass Snipler events and frame | Apache-2.0 |
|
|
25
|
+
| `constants/` | `constants.json`, the single source for values Python and JS share (tap timings, cue states, roles, periods and levels, buttons, gesture names, the keymap), and `makers.json`, the maker registry | Apache-2.0 |
|
|
26
|
+
| `conformance/` | Test vectors any implementation must pass, as plain JSON: 203 schema vectors with an index, and behaviour vectors for the corpus gate, gestures, the keymap, cues, the matrix engine and the routine manifest reader | Apache-2.0 |
|
|
27
|
+
| `tools/` | `generate.py` (writes everything derived from `constants/` and `schema/`, for Python and JS; `--check` fails when any is stale), `pin_vectors.py` (writes the expected values of the cue and matrix vectors from the SDK's own Python), `sync_spec.py`, `release.sh` | Apache-2.0 |
|
|
28
|
+
| `examples/` | A device on the simulator with routines, three example routines, a corpus read from a fake hub, a page that runs from disk | Apache-2.0 |
|
|
29
|
+
| `tests/` | The Python suite (`python3 -m unittest discover -s tests`) and the Node tests under `tests/js/` | Apache-2.0 |
|
|
30
|
+
| `spec/` | The public specification pages, unchanged copies of those published at popboll.com/spec (`spec/SOURCES.json` has the checksums) | CC BY 4.0 |
|
|
31
|
+
|
|
32
|
+
## Install (from a checkout)
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
pip install .
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
import bollardeck
|
|
40
|
+
print(bollardeck.__version__, bollardeck.SPEAKS)
|
|
41
|
+
|
|
42
|
+
import bollardeck.schema as schema
|
|
43
|
+
print(schema.validate("licence", {"scope": "morpus_only", "store_audio": True}))
|
|
44
|
+
# [Problem(pointer='/store_audio', message='must be false, not true', keyword='const')]
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Corpora
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
from bollardeck.corpus import HubClient, discover
|
|
51
|
+
|
|
52
|
+
found = discover(roots=["/media/sd/corpora"], hub=HubClient("https://hub.example", token=TOKEN))
|
|
53
|
+
for corpus in found.corpora:
|
|
54
|
+
verdict = corpus.may("study") # the gate: never raises, always says why
|
|
55
|
+
if verdict:
|
|
56
|
+
pairs = corpus.study_pairs(verdict) # content takes the verdict; there is no other way in
|
|
57
|
+
else:
|
|
58
|
+
print(corpus.id, verdict.reason, verdict.detail)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
`help(bollardeck.corpus)` is the usage guide; `examples/corpus_from_a_fake_hub.py` runs without a
|
|
62
|
+
network. The gate's behaviour is pinned by `conformance/corpus-gate/`.
|
|
63
|
+
|
|
64
|
+
A hub's read token alone is study only for a corpus that is not public. To reach such a corpus's
|
|
65
|
+
tracks, audio, art and bundles, say who the client acts for: `HubClient(..., acting_for="ada@example.org")`
|
|
66
|
+
or `hub.corpus(id, acting_for=...)`. The name goes in the `X-Pop-For` header, never in a URL, and
|
|
67
|
+
is self-declared until sign-in arrives. Also there: `CorpusUnavailable` and `NotAvailable` carry a
|
|
68
|
+
`reason` and the hub's `status`; `corpus.open_audio_ranged(file, verdict, range_header=...)` gives
|
|
69
|
+
a relay the source's status and headers; `hub.listing().from_cache`; `corpus.manifest_view()` (read-only,
|
|
70
|
+
no copy); `hub.corpus_gate()` (the hub's rollout switch, `enforce` or `report`). A clock that is set
|
|
71
|
+
back does not reopen an expired licence held in a cache.
|
|
72
|
+
|
|
73
|
+
## The device layer and routines
|
|
74
|
+
|
|
75
|
+
`bollardeck.device` is the hardware abstraction (with a registry so a board family registers
|
|
76
|
+
itself from outside), button cues, the gesture engine, the keymap resolver and device identity;
|
|
77
|
+
`bollardeck.routines` is the routine API. Each module's docstring is its usage guide. To see them
|
|
78
|
+
work together on the simulator:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
python3 examples/device_on_sim.py
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
A key source may say when a press begins (`"<button> down [t_ms]"`, `hal.base.key_line(1, down=True)`).
|
|
85
|
+
That is a hint and never a gesture: a press is a tap or a hold by the `hold_ms` its release
|
|
86
|
+
states, and every `Gesture` carries that `hold_ms`. A `routine.yaml` may also be one JSON object.
|
|
87
|
+
|
|
88
|
+
`bollardeck.matrix` makes the frames of the 13 x 8 LED matrix and its three RGB LEDs, byte for
|
|
89
|
+
byte what `js/bollardeck.matrix.js` makes (`conformance/matrix/`, 1,135 vectors):
|
|
90
|
+
|
|
91
|
+
```python
|
|
92
|
+
from bollardeck import matrix
|
|
93
|
+
frame = matrix.glyph("boot", 0) # also film, playback, idle, corpus, dj, text, premiere, tone
|
|
94
|
+
frame.to_bytes(), frame.hex(), matrix.to_ascii(frame)
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
The keymap (`bollardeck.constants.KEYMAP`, `schema/keymap.schema.json`) says what each button
|
|
98
|
+
gesture means, and `conformance/gestures/`, `conformance/cues/` and `conformance/cue-render/` pin
|
|
99
|
+
the behaviour for every binding. `conformance/DECISIONS.md` says what the SDK does where the
|
|
100
|
+
schemas and the pages left room.
|
|
101
|
+
|
|
102
|
+
## Working on it
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
python3 -m unittest discover -s tests # also runs the Node tests when node is installed
|
|
106
|
+
node --test tests/js/*.test.js # the browser binding alone
|
|
107
|
+
python3 tools/generate.py # after changing constants/ or schema/
|
|
108
|
+
python3 tools/pin_vectors.py # after changing how a cue or a matrix frame is drawn
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
`jsonschema` and PyYAML, when installed, cross-check the SDK's own validator and its reader for
|
|
112
|
+
`routine.yaml`. Neither is needed to use the SDK; CI installs both for the tests.
|
|
113
|
+
|
|
114
|
+
**popbollard** is Pop Boll's own repository for Bollawax, and it is closed. Where a tool or a test
|
|
115
|
+
here names it (`tools/sync_spec.py --from`, the `BOLLARD_SDK_POPBOLLARD` environment variable of
|
|
116
|
+
`tests/test_reality.py` and `tests/test_corpus_reality.py`), that is a check for its maintainers:
|
|
117
|
+
it reads a checkout of that repository and is skipped without one. Nothing in the SDK needs it.
|
|
118
|
+
|
|
119
|
+
## In a page
|
|
120
|
+
|
|
121
|
+
```html
|
|
122
|
+
<script src="js/bollardeck.js"></script>
|
|
123
|
+
<script>
|
|
124
|
+
bollardeck.schema.validate("licence", {scope: "morpus_only", store_audio: true});
|
|
125
|
+
bollardeck.cues.at([{button: 1, state: "pulse", role: "go"}], performance.now());
|
|
126
|
+
bollardeck.matrix.glyph("boot", 0);
|
|
127
|
+
</script>
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
One tag loads the whole binding: the validator (the twin of `bollardeck.schema` in Python), the
|
|
131
|
+
button cue helpers, the LED matrix frame engine, the gesture engine and keymap resolver, and the
|
|
132
|
+
corpus gate with a hub client on `fetch`, with optional helpers for elements and a canvas. `js/README.md` is the reference, `examples/browser/index.html` runs from disk, and
|
|
133
|
+
`node --test tests/js/*.test.js` runs its tests. `conformance/matrix/` and
|
|
134
|
+
`conformance/cue-render/` hold the behaviour vectors it must pass (`tools/pin_vectors.py` writes
|
|
135
|
+
their expected values), and `tools/generate.py` writes `js/bollardeck.schemas.js`.
|
|
136
|
+
|
|
137
|
+
`CHANGELOG.md` lists what each version added and changed.
|
|
138
|
+
|
|
139
|
+
## Versions
|
|
140
|
+
|
|
141
|
+
The SDK has its own version (`sdk-v<version>` tags). It is not the Bollawax image version.
|
|
142
|
+
`bollardeck.SPEAKS` lists the wire and format versions this SDK speaks, and
|
|
143
|
+
`bollardeck.MIN_BOLLAWAX` is the oldest Bollawax release it is tested against.
|
|
144
|
+
|
|
145
|
+
## Contributing
|
|
146
|
+
|
|
147
|
+
Pull requests are closed for now; see [CONTRIBUTING.md](CONTRIBUTING.md). Issues are welcome.
|
|
148
|
+
|
|
149
|
+
## Licence
|
|
150
|
+
|
|
151
|
+
Code: Apache-2.0 (`LICENSE`). Specification text in `spec/`: CC BY 4.0, "Pop Boll, by Graham
|
|
152
|
+
Smith" (`LICENSES/CC-BY-4.0.txt`). See `NOTICE` for names and trademarks.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "bollard-sdk"
|
|
7
|
+
description = "The Bollawax Bollard SDK: build on the Pop Boll platform"
|
|
8
|
+
readme = "README.md"
|
|
9
|
+
requires-python = ">=3.11"
|
|
10
|
+
license = { text = "Apache-2.0" }
|
|
11
|
+
authors = [{ name = "Graham Smith (Pop Boll)" }]
|
|
12
|
+
dynamic = ["version"]
|
|
13
|
+
dependencies = []
|
|
14
|
+
|
|
15
|
+
[project.urls]
|
|
16
|
+
Homepage = "https://popboll.com/sdk"
|
|
17
|
+
Specification = "https://popboll.com/spec"
|
|
18
|
+
|
|
19
|
+
[tool.setuptools]
|
|
20
|
+
package-dir = { "" = "python" }
|
|
21
|
+
|
|
22
|
+
[tool.setuptools.packages.find]
|
|
23
|
+
where = ["python"]
|
|
24
|
+
|
|
25
|
+
[tool.setuptools.dynamic]
|
|
26
|
+
version = { attr = "bollardeck._version.__version__" }
|