@ebusd/ebus-typespec 0.1.0

package/dist/src/rules/no-tuple.rule.js

@@ -0,0 +1,17 @@
+import { createRule } from "@typespec/compiler";
+export const noTupleRule = createRule({
+    name: "no-tuple",
+    severity: "warning",
+    description: "Make sure tuple is not used.",
+    messages: {
+        default: "Tuple shouldn't be used with this library.",
+    },
+    create: (context) => {
+        return {
+            tuple: (target) => {
+                context.reportDiagnostic({ target });
+            },
+        };
+    },
+});
+//# sourceMappingURL=no-tuple.rule.js.map

package/dist/src/rules/no-tuple.rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-tuple.rule.js","sourceRoot":"","sources":["../../../src/rules/no-tuple.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACpC,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,8BAA8B;IAC3C,QAAQ,EAAE;QACR,OAAO,EAAE,4CAA4C;KACtD;IACD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE;gBAChB,OAAO,CAAC,gBAAgB,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/src/rules/no-union.rule.d.ts

@@ -0,0 +1,3 @@
+export declare const noUnionRule: import("@typespec/compiler").LinterRuleDefinition<"no-union", {
+    readonly default: "Union shouldn't be used with this library.";
+}>;

package/dist/src/rules/no-union.rule.js

@@ -0,0 +1,20 @@
+import { createRule } from "@typespec/compiler";
+export const noUnionRule = createRule({
+    name: "no-union",
+    severity: "warning",
+    description: "Make sure union is not used.",
+    messages: {
+        default: "Union shouldn't be used with this library.",
+    },
+    create: (context) => {
+        return {
+            union: (target) => {
+                context.reportDiagnostic({ target });
+            },
+            unionVariant: (target) => {
+                context.reportDiagnostic({ target });
+            },
+        };
+    },
+});
+//# sourceMappingURL=no-union.rule.js.map

package/dist/src/rules/no-union.rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-union.rule.js","sourceRoot":"","sources":["../../../src/rules/no-union.rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,MAAM,WAAW,GAAG,UAAU,CAAC;IACpC,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,8BAA8B;IAC3C,QAAQ,EAAE;QACR,OAAO,EAAE,4CAA4C;KACtD;IACD,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;QAClB,OAAO;YACL,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE;gBAChB,OAAO,CAAC,gBAAgB,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC;YACrC,CAAC;YACD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;gBACvB,OAAO,CAAC,gBAAgB,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/src/testing/index.d.ts

@@ -0,0 +1,2 @@
+import { type TypeSpecTestLibrary } from "@typespec/compiler/testing";
+export declare const EbusTestLibrary: TypeSpecTestLibrary;

package/dist/src/testing/index.js

@@ -0,0 +1,6 @@
+import { createTestLibrary, findTestPackageRoot } from "@typespec/compiler/testing";
+export const EbusTestLibrary = createTestLibrary({
+    name: "ebus",
+    packageRoot: await findTestPackageRoot(import.meta.url),
+});
+//# sourceMappingURL=index.js.map

package/dist/src/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAE,mBAAmB,EAA2B,MAAM,4BAA4B,CAAC;AAE5G,MAAM,CAAC,MAAM,eAAe,GAAwB,iBAAiB,CAAC;IACpE,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,MAAM,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;CACxD,CAAC,CAAC"}

package/docs.md

@@ -0,0 +1,453 @@
+# ebus
+
+TypeSpec library for defining eBUS messages and emitting to ebusd CSV.
+
+## Install
+
+```bash
+npm install https://github.com/john30/ebus-typespec
+```
+
+## Emitter
+
+### Usage
+
+1. Via the command line
+
+```bash
+tsp compile . --emit=ebus
+```
+
+2. Via the config
+
+```yaml
+emit:
+  - "ebus"
+```
+
+### Emitter options
+
+#### `file-type`
+
+**Type:** `"csv"`
+
+Serialize the schema as csv
+
+#### `includes`
+
+**Type:** `boolean`
+
+Emit includes files as includes instead of inline (incomplete!)
+
+## Linter
+
+### Usage
+
+Add the following in `tspconfig.yaml`:
+
+```yaml
+linter:
+  extends:
+    - ebus/recommended
+```
+
+### RuleSets
+
+Available ruleSets:
+
+- [`ebus/recommended`](#ebus/recommended)
+- [`ebus/all`](#ebus/all)
+
+### Rules
+
+| Name                 | Description                       |
+| -------------------- | --------------------------------- |
+| `ebus/no-function`   | Make sure function is not used.   |
+| `ebus/no-interface`  | Make sure interface is not used.  |
+| `ebus/no-intrinsic`  | Make sure intrinsic is not used.  |
+| `ebus/no-literal`    | Make sure literal is not used.    |
+| `ebus/no-object`     | Make sure object is not used.     |
+| `ebus/no-operation`  | Make sure operation is not used.  |
+| `ebus/no-projection` | Make sure projection is not used. |
+| `ebus/no-template`   | Make sure template is not used.   |
+| `ebus/no-tuple`      | Make sure tuple is not used.      |
+| `ebus/no-union`      | Make sure union is not used.      |
+
+## Decorators
+
+### Ebus
+
+- [`@auth`](#@auth)
+- [`@base`](#@base)
+- [`@condition`](#@condition)
+- [`@divisor`](#@divisor)
+- [`@ext`](#@ext)
+- [`@factor`](#@factor)
+- [`@id`](#@id)
+- [`@in`](#@in)
+- [`@inherit`](#@inherit)
+- [`@out`](#@out)
+- [`@passive`](#@passive)
+- [`@qq`](#@qq)
+- [`@unit`](#@unit)
+- [`@values`](#@values)
+- [`@write`](#@write)
+- [`@zz`](#@zz)
+
+#### `@auth`
+
+Define authentication level.
+
+```typespec
+@Ebus.auth(auth: valueof string)
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name | Type                    | Description |
+| ---- | ----------------------- | ----------- |
+| auth | `valueof scalar string` |             |
+
+#### `@base`
+
+Define the base message ID to be combined with an extension ID.
+
+```typespec
+@Ebus.base(pb: valueof Ebus.Pb, sb: valueof Ebus.Sb, ...id: valueof Ebus.Symbol[])
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name | Type                          | Description               |
+| ---- | ----------------------------- | ------------------------- |
+| pb   | `valueof scalar Ebus.Pb`      | the primary message ID.   |
+| sb   | `valueof scalar Ebus.Sb`      | the secondary message ID. |
+| id   | `valueof model Ebus.Symbol[]` | further message ID parts. |
+
+#### `@condition`
+
+Define the condition(s) for the whole message (if given multiple times, all conditions must be met).
+
+```typespec
+@Ebus.condition(property: ModelProperty | Model, ...values: valueof string[])
+```
+
+##### Target
+
+`union Namespace | Model | UnionVariant`
+
+##### Parameters
+
+| Name     | Type                           | Description                                                                                                             |
+| -------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- |
+| property | `union ModelProperty \| Model` | the referenced model property, or a model in case of existance check or single property only.                           |
+| values   | `valueof model string[]`       | the optional alternative values the property needs to match (one of the values must match for the condition to be met). |
+
+#### `@divisor`
+
+Define the divisor.
+
+```typespec
+@Ebus.divisor(value: valueof numeric)
+```
+
+##### Target
+
+`union numeric | plainTime | ModelProperty`
+
+##### Parameters
+
+| Name  | Type                     | Description  |
+| ----- | ------------------------ | ------------ |
+| value | `valueof scalar numeric` | the divisor. |
+
+#### `@ext`
+
+Define the extension message ID to be combined with a base ID.
+
+```typespec
+@Ebus.ext(...id: valueof Ebus.Symbol[])
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name | Type                          | Description                  |
+| ---- | ----------------------------- | ---------------------------- |
+| id   | `valueof model Ebus.Symbol[]` | message ID extensions parts. |
+
+#### `@factor`
+
+Define the factor.
+
+```typespec
+@Ebus.factor(value: valueof numeric)
+```
+
+##### Target
+
+`union numeric | plainTime | ModelProperty`
+
+##### Parameters
+
+| Name  | Type                     | Description |
+| ----- | ------------------------ | ----------- |
+| value | `valueof scalar numeric` | the factor. |
+
+#### `@id`
+
+Define the whole message ID.
+
+```typespec
+@Ebus.id(pb: valueof Ebus.Pb, sb: valueof Ebus.Sb, ...id: valueof Ebus.Symbol[])
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name | Type                          | Description               |
+| ---- | ----------------------------- | ------------------------- |
+| pb   | `valueof scalar Ebus.Pb`      | the primary message ID.   |
+| sb   | `valueof scalar Ebus.Sb`      | the secondary message ID. |
+| id   | `valueof model Ebus.Symbol[]` | further message ID parts. |
+
+#### `@in`
+
+Define message part inbound from target.
+
+```typespec
+@Ebus.in
+```
+
+##### Target
+
+`ModelProperty`
+
+##### Parameters
+
+None
+
+#### `@inherit`
+
+Define the inherited model(s).
+
+```typespec
+@Ebus.inherit(...models: valueof Model[])
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name   | Type                    | Description       |
+| ------ | ----------------------- | ----------------- |
+| models | `valueof model Model[]` | inherited models. |
+
+#### `@out`
+
+Define message part outbound to target.
+
+```typespec
+@Ebus.out
+```
+
+##### Target
+
+`ModelProperty`
+
+##### Parameters
+
+None
+
+#### `@passive`
+
+Define passive only.
+
+```typespec
+@Ebus.passive
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+None
+
+#### `@qq`
+
+Define the source address.
+
+```typespec
+@Ebus.qq(value?: valueof Ebus.Source)
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+| Name  | Type                         | Description            |
+| ----- | ---------------------------- | ---------------------- |
+| value | `valueof scalar Ebus.Source` | the source address QQ. |
+
+#### `@unit`
+
+Define the unit.
+
+```typespec
+@Ebus.unit(value: valueof string)
+```
+
+##### Target
+
+`union numeric | ModelProperty`
+
+##### Parameters
+
+| Name  | Type                    | Description |
+| ----- | ----------------------- | ----------- |
+| value | `valueof scalar string` | the unit.   |
+
+#### `@values`
+
+Define the known values.
+
+```typespec
+@Ebus.values(values: Enum)
+```
+
+##### Target
+
+`union numeric | boolean | ModelProperty`
+
+##### Parameters
+
+| Name   | Type   | Description |
+| ------ | ------ | ----------- |
+| values | `Enum` |             |
+
+#### `@write`
+
+Define write direction.
+
+```typespec
+@Ebus.write
+```
+
+##### Target
+
+`Model`
+
+##### Parameters
+
+None
+
+#### `@zz`
+
+Define the target address.
+
+```typespec
+@Ebus.zz(value?: valueof Ebus.Target)
+```
+
+##### Target
+
+`union Model | Namespace`
+
+##### Parameters
+
+| Name  | Type                         | Description            |
+| ----- | ---------------------------- | ---------------------- |
+| value | `valueof scalar Ebus.Target` | the target address ZZ. |
+
+### Ebus.internal
+
+- [`@bcd`](#@bcd)
+- [`@hex`](#@hex)
+- [`@maxBits`](#@maxbits)
+- [`@reverse`](#@reverse)
+
+#### `@bcd`
+
+Define BCD encoding.
+
+```typespec
+@Ebus.internal.bcd
+```
+
+##### Target
+
+`Scalar`
+
+##### Parameters
+
+None
+
+#### `@hex`
+
+Define HEX encoding.
+
+```typespec
+@Ebus.internal.hex
+```
+
+##### Target
+
+`Scalar`
+
+##### Parameters
+
+None
+
+#### `@maxBits`
+
+Define the max bits.
+
+```typespec
+@Ebus.internal.maxBits(value: valueof numeric)
+```
+
+##### Target
+
+`scalar numeric`
+
+##### Parameters
+
+| Name  | Type                     | Description   |
+| ----- | ------------------------ | ------------- |
+| value | `valueof scalar numeric` | the max bits. |
+
+#### `@reverse`
+
+Define reverse representation.
+
+```typespec
+@Ebus.internal.reverse
+```
+
+##### Target
+
+`Scalar`
+
+##### Parameters
+
+None

package/lib/decorators.tsp

@@ -0,0 +1,127 @@
+import "../dist/src/decorators.js";
+import "./types.tsp";
+
+using TypeSpec.Reflection;
+
+namespace Ebus;
+
+
+/**
+ * Define the condition(s) for the whole message (if given multiple times, all conditions must be met).
+ * @param property the referenced model property, or a model in case of existance check or single property only.
+ * @param values the optional alternative values the property needs to match (one of the values must match for the condition to be met).
+ */
+extern dec condition(target: Namespace|Model|UnionVariant, property: ModelProperty|Model, ...values: valueof string[]);
+
+/**
+ * Define write direction.
+ */
+extern dec write(target: Model);
+
+/**
+ * Define passive only.
+ */
+extern dec passive(target: Model);
+
+/**
+ * Define authentication level.
+ */
+extern dec auth(target: Model, auth: valueof string);
+
+/**
+ * Define the source address.
+ * @param value the source address QQ.
+ */
+extern dec qq(source: Model, value?: valueof Source);
+
+/**
+ * Define the target address.
+ * @param value the target address ZZ.
+ */
+extern dec zz(target: Model|Namespace, value?: valueof Target);
+
+/**
+ * Define the whole message ID.
+ * @param pb the primary message ID.
+ * @param sb the secondary message ID.
+ * @param id further message ID parts.
+ */
+extern dec id(target: Model, pb: valueof Pb, sb: valueof Sb, ...id: valueof Symbol[]);
+
+/**
+ * Define the base message ID to be combined with an extension ID.
+ * @param pb the primary message ID.
+ * @param sb the secondary message ID.
+ * @param id further message ID parts.
+ */
+extern dec base(target: Model, pb: valueof Pb, sb: valueof Sb, ...id: valueof Symbol[]);
+
+/**
+ * Define the extension message ID to be combined with a base ID.
+ * @param id message ID extensions parts.
+ */
+extern dec ext(target: Model, ...id: valueof Symbol[]);
+
+/**
+ * Define the inherited model(s).
+ * @param models inherited models.
+ */
+extern dec inherit(target: Model, ...models: valueof Model[]);
+
+/**
+ * Define message part outbound to target.
+ */
+extern dec out(target: ModelProperty);
+
+/**
+ * Define message part inbound from target.
+ */
+extern dec in(target: ModelProperty);
+
+/**
+ * Define the unit.
+ * @param value the unit.
+ */
+extern dec unit(target: numeric|ModelProperty, value: valueof string);
+
+/**
+ * Define the divisor.
+ * @param value the divisor.
+ */
+extern dec divisor(target: numeric|plainTime|ModelProperty, value: valueof numeric);
+
+/**
+ * Define the factor.
+ * @param value the factor.
+ */
+extern dec factor(target: numeric|plainTime|ModelProperty, value: valueof numeric);
+
+/**
+ * Define the known values.
+ * @param value the divisor.
+ */
+extern dec values(target: numeric|boolean|ModelProperty, values: Enum);
+
+
+namespace internal {
+  /**
+   * Define reverse representation.
+   */
+  extern dec reverse(target: Scalar);
+
+  /**
+   * Define BCD encoding.
+   */
+  extern dec bcd(target: Scalar);
+
+  /**
+   * Define HEX encoding.
+   */
+  extern dec hex(target: Scalar);
+
+  /**
+   * Define the max bits.
+   * @param value the max bits.
+   */
+  extern dec maxBits(target: numeric, value: valueof numeric);
+}

package/lib/main.tsp

@@ -0,0 +1,3 @@
+import "./decorators.tsp";
+import "./types.tsp";
+import "./models.tsp";

package/lib/models.tsp

@@ -0,0 +1,61 @@
+import "./types.tsp";
+
+namespace Ebus;
+using Ebus.num;
+
+namespace id {
+
+  enum manufacturers {
+    Dungs: 0x06,
+    "FH Ostfalia": 0x0f,
+    TEM: 0x10,
+    Lamberti: 0x11,
+    CEB: 0x14,
+    "Landis-Staefa": 0x15,
+    FERRO: 0x16,
+    MONDIAL: 0x17,
+    Wikon: 0x18,
+    Wolf: 0x19,
+    RAWE: 0x20,
+    Satronic: 0x30,
+    ENCON: 0x40,
+    Kromschröder: 0x50,
+    Eberle: 0x60,
+    EBV: 0x65,
+    Grässlin: 0x75,
+    "ebm-papst": 0x85,
+    SIG: 0x95,
+    Theben: 0xa5,
+    Thermowatt: 0xa7,
+    Vaillant: 0xb5,
+    Toby: 0xc0,
+    Weishaupt: 0xc5,
+    "ebusd.eu": 0xfd,
+    ebusd: 0xfd,
+    // Pb, // <= this is how to declare the base type as it seems for unions, see https://github.com/microsoft/typespec/issues/2737
+  }
+
+  @values(manufacturers)
+  scalar manufacturer extends UCH
+
+  model id_read {}
+  @zz(BROADCAST)
+  @passive
+  model id_bcast {}
+  @zz(BROADCAST)
+  model id_write {}
+
+  /** identification */
+  @inherit(id_read, id_bcast, id_write) @id(0x07, 0x04)
+  model id {
+    /** device manufacturer */
+    mf?: manufacturer,
+    /** device id */
+    @maxLength(5)
+    id?: str.STR,
+    /** software version */
+    sw?: num.PIN,
+    /** hardware version */
+    hw?: num.PIN,
+  }
+}