@springfield/ham-radio-api 17.6.0 → 17.7.0
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.
- package/README.md +8 -84
- package/dist/radio/memory-map.d.ts +37 -0
- package/dist/radio/memory-map.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/radio/memory-map.ts +40 -0
package/README.md
CHANGED
|
@@ -1,89 +1,13 @@
|
|
|
1
1
|
# ham-radio-api
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
`yarn install`
|
|
5
|
-
`yarn prepare`
|
|
3
|
+
Shared TypeScript types and schemas for HamBench: protocol DSL, memory maps, serial config, branded frequencies, and license types.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
Packages that talk to radios depend on this library. It does not open a serial port.
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
Docs: [HamBench developer docs](https://springfield-ham-radio.github.io/ham-radio-docs/developer/)
|
|
10
8
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
|
17
|
-
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
|
18
|
-
|
|
19
|
-
## Test and Deploy
|
|
20
|
-
|
|
21
|
-
Use the built-in continuous integration in GitLab.
|
|
22
|
-
|
|
23
|
-
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
|
24
|
-
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
|
25
|
-
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
26
|
-
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
27
|
-
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
# Editing this README
|
|
32
|
-
|
|
33
|
-
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
34
|
-
|
|
35
|
-
## Suggestions for a good README
|
|
36
|
-
|
|
37
|
-
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
38
|
-
|
|
39
|
-
## Name
|
|
40
|
-
|
|
41
|
-
Choose a self-explaining name for your project.
|
|
42
|
-
|
|
43
|
-
## Description
|
|
44
|
-
|
|
45
|
-
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
46
|
-
|
|
47
|
-
## Badges
|
|
48
|
-
|
|
49
|
-
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
50
|
-
|
|
51
|
-
## Visuals
|
|
52
|
-
|
|
53
|
-
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
54
|
-
|
|
55
|
-
## Installation
|
|
56
|
-
|
|
57
|
-
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
58
|
-
|
|
59
|
-
## Usage
|
|
60
|
-
|
|
61
|
-
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
62
|
-
|
|
63
|
-
## Support
|
|
64
|
-
|
|
65
|
-
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
66
|
-
|
|
67
|
-
## Roadmap
|
|
68
|
-
|
|
69
|
-
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
70
|
-
|
|
71
|
-
## Contributing
|
|
72
|
-
|
|
73
|
-
State if you are open to contributions and what your requirements are for accepting them.
|
|
74
|
-
|
|
75
|
-
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
76
|
-
|
|
77
|
-
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
78
|
-
|
|
79
|
-
## Authors and acknowledgment
|
|
80
|
-
|
|
81
|
-
Show your appreciation to those who have contributed to the project.
|
|
82
|
-
|
|
83
|
-
## License
|
|
84
|
-
|
|
85
|
-
For open source projects, say how it is licensed.
|
|
86
|
-
|
|
87
|
-
## Project status
|
|
88
|
-
|
|
89
|
-
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
9
|
+
```bash
|
|
10
|
+
corepack enable
|
|
11
|
+
yarn install
|
|
12
|
+
yarn build
|
|
13
|
+
```
|
|
@@ -97,9 +97,40 @@ export type RadioMemoryMapValueKind = {
|
|
|
97
97
|
kind: "dcs-index";
|
|
98
98
|
values: number[];
|
|
99
99
|
};
|
|
100
|
+
/** Warning banner shown at the top of a settings group in the UI. */
|
|
101
|
+
export interface RadioMemoryMapGroupWarning {
|
|
102
|
+
title: string;
|
|
103
|
+
description: string;
|
|
104
|
+
}
|
|
105
|
+
/**
|
|
106
|
+
* Panel section inside a left-nav settings group.
|
|
107
|
+
* Field `ui.subgroup` references `id`. Declaration order is display order.
|
|
108
|
+
*/
|
|
109
|
+
export interface RadioMemoryMapSubgroup {
|
|
110
|
+
id: string;
|
|
111
|
+
label: string;
|
|
112
|
+
description?: string;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Named UI group for radio-wide settings (left navigation).
|
|
116
|
+
* Field `ui.group` references `id`. Declaration order is display order.
|
|
117
|
+
*/
|
|
118
|
+
export interface RadioMemoryMapGroup {
|
|
119
|
+
id: string;
|
|
120
|
+
label: string;
|
|
121
|
+
description?: string;
|
|
122
|
+
/** Iconify icon name (for example `i-lucide-sliders-horizontal`). */
|
|
123
|
+
icon?: string;
|
|
124
|
+
warning?: RadioMemoryMapGroupWarning;
|
|
125
|
+
/** Optional sections shown inside this group in the settings panel. */
|
|
126
|
+
groups?: RadioMemoryMapSubgroup[];
|
|
127
|
+
}
|
|
100
128
|
/** UI metadata for a non-reserved field. */
|
|
101
129
|
export interface RadioMemoryMapFieldUi {
|
|
130
|
+
/** Settings group id. Matches {@link RadioMemoryMapGroup.id} when groups are declared. */
|
|
102
131
|
group: string;
|
|
132
|
+
/** Optional panel section id. Matches {@link RadioMemoryMapSubgroup.id} on the parent group. */
|
|
133
|
+
subgroup?: string;
|
|
103
134
|
label: string;
|
|
104
135
|
widget: RadioMemoryMapWidget;
|
|
105
136
|
description?: string;
|
|
@@ -192,6 +223,12 @@ export interface RadioMemoryMap {
|
|
|
192
223
|
/** Optional map version for tooling. */
|
|
193
224
|
version?: string;
|
|
194
225
|
description?: string;
|
|
226
|
+
/**
|
|
227
|
+
* Named settings groups for schema-driven forms.
|
|
228
|
+
* Top-level groups are the Settings left nav. Nested `groups` are panel sections.
|
|
229
|
+
* Fields with `ui.group` matching a group `id` are shown together; unused groups are omitted.
|
|
230
|
+
*/
|
|
231
|
+
groups?: RadioMemoryMapGroup[];
|
|
195
232
|
structs: RadioMemoryMapStruct[];
|
|
196
233
|
/** Optional projection from channel structs into RadioProgram.channels. */
|
|
197
234
|
channelBindings?: RadioMemoryMapChannelBindings;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"memory-map.d.ts","sourceRoot":"","sources":["../../src/radio/memory-map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qDAAqD;AACrD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAElE,sEAAsE;AACtE,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAEhH,8CAA8C;AAC9C,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,CAAA;CAAE,CAAC;AAEvD,2DAA2D;AAC3D,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,GAClC;IACE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEN,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,oBAAoB,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,IAAI,EAAE,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7C,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,EAAE,CAAC,EAAE,qBAAqB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,2EAA2E;IAC3E,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD"}
|
|
1
|
+
{"version":3,"file":"memory-map.d.ts","sourceRoot":"","sources":["../../src/radio/memory-map.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,qDAAqD;AACrD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAElE,sEAAsE;AACtE,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,iBAAiB,EAAE,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC;AAEhH,8CAA8C;AAC9C,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,CAAA;CAAE,CAAC;AAEvD,2DAA2D;AAC3D,MAAM,MAAM,uBAAuB,GAC/B;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,GAClC;IACE,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,gFAAgF;IAChF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GACD;IACE,IAAI,EAAE,QAAQ,CAAC;IACf,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,GACD;IACE;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEN,qEAAqE;AACrE,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,uEAAuE;IACvE,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACnC;AAED,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,0FAA0F;IAC1F,KAAK,EAAE,MAAM,CAAC;IACd,gGAAgG;IAChG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,oBAAoB,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,IAAI,EAAE,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7C,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,uBAAuB,CAAC;IAChC,EAAE,CAAC,EAAE,qBAAqB,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,0EAA0E;IAC1E,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IACtB,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sEAAsE;IACtE,SAAS,CAAC,EAAE,uBAAuB,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC/B,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,2EAA2E;IAC3E,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACjD"}
|
package/package.json
CHANGED
package/src/radio/memory-map.ts
CHANGED
|
@@ -97,9 +97,43 @@ export type RadioMemoryMapValueKind =
|
|
|
97
97
|
values: number[];
|
|
98
98
|
};
|
|
99
99
|
|
|
100
|
+
/** Warning banner shown at the top of a settings group in the UI. */
|
|
101
|
+
export interface RadioMemoryMapGroupWarning {
|
|
102
|
+
title: string;
|
|
103
|
+
description: string;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Panel section inside a left-nav settings group.
|
|
108
|
+
* Field `ui.subgroup` references `id`. Declaration order is display order.
|
|
109
|
+
*/
|
|
110
|
+
export interface RadioMemoryMapSubgroup {
|
|
111
|
+
id: string;
|
|
112
|
+
label: string;
|
|
113
|
+
description?: string;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Named UI group for radio-wide settings (left navigation).
|
|
118
|
+
* Field `ui.group` references `id`. Declaration order is display order.
|
|
119
|
+
*/
|
|
120
|
+
export interface RadioMemoryMapGroup {
|
|
121
|
+
id: string;
|
|
122
|
+
label: string;
|
|
123
|
+
description?: string;
|
|
124
|
+
/** Iconify icon name (for example `i-lucide-sliders-horizontal`). */
|
|
125
|
+
icon?: string;
|
|
126
|
+
warning?: RadioMemoryMapGroupWarning;
|
|
127
|
+
/** Optional sections shown inside this group in the settings panel. */
|
|
128
|
+
groups?: RadioMemoryMapSubgroup[];
|
|
129
|
+
}
|
|
130
|
+
|
|
100
131
|
/** UI metadata for a non-reserved field. */
|
|
101
132
|
export interface RadioMemoryMapFieldUi {
|
|
133
|
+
/** Settings group id. Matches {@link RadioMemoryMapGroup.id} when groups are declared. */
|
|
102
134
|
group: string;
|
|
135
|
+
/** Optional panel section id. Matches {@link RadioMemoryMapSubgroup.id} on the parent group. */
|
|
136
|
+
subgroup?: string;
|
|
103
137
|
label: string;
|
|
104
138
|
widget: RadioMemoryMapWidget;
|
|
105
139
|
description?: string;
|
|
@@ -197,6 +231,12 @@ export interface RadioMemoryMap {
|
|
|
197
231
|
/** Optional map version for tooling. */
|
|
198
232
|
version?: string;
|
|
199
233
|
description?: string;
|
|
234
|
+
/**
|
|
235
|
+
* Named settings groups for schema-driven forms.
|
|
236
|
+
* Top-level groups are the Settings left nav. Nested `groups` are panel sections.
|
|
237
|
+
* Fields with `ui.group` matching a group `id` are shown together; unused groups are omitted.
|
|
238
|
+
*/
|
|
239
|
+
groups?: RadioMemoryMapGroup[];
|
|
200
240
|
structs: RadioMemoryMapStruct[];
|
|
201
241
|
/** Optional projection from channel structs into RadioProgram.channels. */
|
|
202
242
|
channelBindings?: RadioMemoryMapChannelBindings;
|