@ebusd/ebus-typespec 0.4.0 → 0.6.0

package/lib/types.tsp

@@ -1,38 +1,38 @@
 namespace Ebus;
 
 /** A symbol on the bus. */
-scalar Symbol extends uint8;
+scalar symbol extends uint8;
 
 /** List of special symbols. */
-union symbols {
+union Symbols {
   SYN: 0xaa,
   ESC: 0xa9,
-  Symbol,
+  symbol,
 }
 
 /** A source address 'QQ. */
-scalar Source extends Symbol;
+scalar source extends symbol;
 
 /** A target address 'ZZ'. */
-scalar Target extends Symbol;
+scalar target extends symbol;
 
 /** List of special target addresses. */
-union targets {
+union Targets {
   /** the special broadcast target address. */
-  Broadcast: 0xfe,
-  Target,
+  broadcast: 0xfe,
+  target,
 }
 /** the special broadcast target address. */
-alias BROADCAST = targets.Broadcast;
+alias BROADCAST = Targets.broadcast;
 
 /** the primary command symbol 'PB'. */
-scalar Pb extends Symbol;
+scalar pb extends symbol;
 
 /** the secondary command symbol 'SB'. */
-scalar Sb extends Symbol;
+scalar sb extends symbol;
 
 /** The known numeric base data types. */
-namespace num {
+namespace Num {
   // 1 byte length
 
   /** bit 0. */
@@ -60,10 +60,10 @@ namespace num {
   @encode("uint8")
   scalar BI7 extends boolean;
   /** 6 bits starting from bit 0. */
-  @internal.maxBits(6)
+  @Internal.maxBits(6)
   scalar BI0_6 extends uint8;
   /** 7 bits starting from bit 0. */
-  @internal.maxBits(7)
+  @Internal.maxBits(7)
   scalar BI0_7 extends uint8;
 
   /** 1 byte unsigned integer, 0 - 254, replacement 0xff. */
@@ -73,13 +73,13 @@ namespace num {
   /** same as SCH. */
   alias D1B = SCH;
   /** 1 byte unsigned decimal in BCD, 0 - 99, replacement 0xff. */
-  @internal.bcd
+  @Internal.bcd
   scalar BCD extends uint8;
   /**
    * 1 byte unsigned decimal digits in hex, 0 - 99
    * (0x00 - 0x63).
    */
-  @internal.hex
+  @Internal.hex
   scalar HCD extends uint8;
   /**
    * 1 byte unsigned number (fraction 1/2), 0 - 100
@@ -91,27 +91,27 @@ namespace num {
   // 2 byte length
 
   /** 2 byte unsigned decimal in BCD, shown as 4 digits, 0000 - 9999 (fixed length). */
-  @internal.reverse
-  @internal.bcd
+  @Internal.reverse
+  @Internal.bcd
   scalar PIN extends uint16;
   /** 2 byte unsigned integer, 0 - 65534, replacement 0xffff. */
   scalar UIN extends uint16;
   /** 2 byte unsigned integer, 0 - 65534, replacement 0xffff, big endian. */
-  @internal.reverse
+  @Internal.reverse
   scalar UIR extends UIN;
   /** 2 byte signed integer, -32767 - +32767, replacement 0x7fff. */
   scalar SIN extends int16;
   /** 2 byte signed integer, -32767 - +32767, replacement 0x7fff, big endian. */
-  @internal.reverse
+  @Internal.reverse
   scalar SIR extends SIN;
   /** 2 byte unsigned decimal in BCD, 0 - 9999, replacement 0xffff. */
-  @internal.bcd
+  @Internal.bcd
   scalar BCD2 extends uint16;
   /**
    * 2 byte unsigned decimal digits in hex, 0 - 9999
    * (0x00,0x00 - 0x63,0x63).
    */
-  @internal.hex
+  @Internal.hex
   scalar HCD2 extends uint16;
   /**
    * 2 byte signed number (fraction 1/256), -127.99 - +127.99 .
@@ -131,20 +131,20 @@ namespace num {
   /**
    * 2 byte signed number (fraction 1/1000), -32.767 - +32.767, big endian.
    */
-  @internal.reverse
+  @Internal.reverse
   scalar FLR extends FLT;
 
   // 3 byte length
 
   //todo 3 byte int
   /** 3 byte unsigned decimal in BCD, 0 - 999999, replacement 0xffffff. */
-  @internal.bcd
+  @Internal.bcd
   scalar BCD3 extends uint32; // todo 3 bytes
   /**
    * 3 byte unsigned decimal digits in hex, 0 - 999999
    * (0x00,0x00,0x00 - 0x63,0x63,0x63).
    */
-  @internal.hex
+  @Internal.hex
   scalar HCD3 extends uint32; // todo 3 bytes
 
   // 4 byte length
@@ -152,21 +152,21 @@ namespace num {
   /** 4 byte unsigned integer, 0 - 4294967294, replacement 0xffffffff. */
   scalar ULG extends uint32;
   /** 4 byte unsigned integer, 0 - 4294967294, replacement 0xffffffff, big endian. */
-  @internal.reverse
+  @Internal.reverse
   scalar ULR extends ULG;
   /** 4 byte signed integer, -2147483647 - +2147483647, replacement 0x7fffffff. */
   scalar SLG extends int32;
   /** 4 byte signed integer, -2147483647 - +2147483647, replacement 0x7fffffff, big endian. */
-  @internal.reverse
+  @Internal.reverse
   scalar SLR extends SLG;
   /** 4 byte unsigned decimal in BCD, 0 - 99999999, replacement 0xffffffff. */
-  @internal.bcd
+  @Internal.bcd
   scalar BCD4 extends uint32;
   /**
    * 4 byte unsigned decimal digits in hex, 0 - 99999999
    * (0x00,0x00,0x00,0x00 - 0x63,0x63,0x63,0x63).
    */
-  @internal.hex
+  @Internal.hex
   scalar HCD4 extends uint32;
   /**
    * 4 byte signed number in IEEE 754
@@ -177,12 +177,12 @@ namespace num {
    * 4 byte signed number in IEEE 754, big endian
    * (IEEE 754 binary32: 1 bit sign, 8 bits exponent, 23 bits significand).
    */
-  @internal.reverse
+  @Internal.reverse
   scalar EXR extends EXP;
 }
 
 /** The known string base data types. */
-namespace str {
+namespace Str {
   /** >= 1 byte character string filled up with space. */
   @maxLength(31)
   scalar STR extends string;
@@ -194,13 +194,13 @@ namespace str {
   @maxLength(31)
   scalar IGN extends string; // todo bytes would be more logical, but have not length limit
   /** >= 1 byte hex digit string, usually separated by space, e.g. 0a 1b 2c 3d. */
-  @internal.hex
+  @Internal.hex
   @maxLength(31)
   scalar HEX extends string;
 }
 
 /** The known date/time base data types. */
-namespace dtm {
+namespace Dtm {
   /**
    * 1 byte weekday, "Mon" - "Sun"
    * (0x00 - 0x06).
@@ -215,7 +215,7 @@ namespace dtm {
    * 4 byte date with weekday in BCD, 01.01.2000 - 31.12.2099
    * (0x01,0x01,WW,0x00 - 0x31,0x12,WW,0x99, WW is weekday Mon=0x01 - Sun=0x07, replacement 0xff).
    */
-  @internal.bcd
+  @Internal.bcd
   @encode("", uint32)
   scalar BDA extends plainDate;
   /** same as BDA. */
@@ -234,7 +234,7 @@ namespace dtm {
    * 4 byte date with weekday, 01.01.2000 - 31.12.2099
    * (0x01,0x01,WW,0x00 - 0x1f,0x0c,WW,0x63, WW is weekday Mon=0x01 - Sun=0x07, replacement 0xff).
    */
-  @internal.hex
+  @Internal.hex
   @encode("", uint32)
   scalar HDA extends plainDate;
   /** same as HDA. */
@@ -261,41 +261,41 @@ namespace dtm {
    * 3 byte time in BCD, 00:00:00 - 23:59:59, seconds first
    * (0x00,0x00,0x00 - 0x59,0x59,0x23).
    */
-  @internal.bcd
-  @internal.reverse
+  @Internal.bcd
+  @Internal.reverse
   scalar BTI extends plainTime; // todo 3 bytes
   /**
    * 3 byte time, 00:00:00 - 23:59:59
    * (0x00,0x00,0x00 - 0x17,0x3b,0x3b).
    */
-  @internal.hex
+  @Internal.hex
   scalar HTI extends plainTime; // todo 3 bytes
   /**
    * 3 byte time, 00:00:00 - 23:59:59, seconds first [Vaillant type]
    * (0x00,0x00,0x00 - 0x3b,0x3b,0x17, replacement 0x63).
    */
-  @internal.reverse
+  @Internal.reverse
   scalar VTI extends HTI;
   /**
    * 2 byte time as hh:mm in BCD, 00:00 - 23:59, minutes first
    * (0x00,0x00 - 0x59,0x23, replacement 0xff).
    */
-  @internal.bcd
-  @internal.reverse
+  @Internal.bcd
+  @Internal.reverse
   @encode("", uint16)
   scalar BTM extends plainTime;
   /**
    * 2 byte time as hh:mm, 00:00 - 23:59
    * (0x00,0x00 - 0x17,0x3b).
    */
-  @internal.hex
+  @Internal.hex
   @encode("", uint16)
   scalar HTM extends plainTime;
   /**
    * 2 byte time as hh:mm, 00:00 - 23:59, minutes first [Vaillant type]
    * (0x00,0x00 - 0x3b,0x17, replacement 0xff)
    */
-  @internal.reverse
+  @Internal.reverse
   scalar VTM extends BTM;
   /**
    * 2 byte time, minutes since last midnight, 00:00 - 24:00
@@ -315,77 +315,77 @@ namespace dtm {
    * (minutes div 30 + hour * 2 as integer).
    */
   @divisor(30)
-  @encode("", num.BI0_6)
+  @encode("", Num.BI0_6)
   scalar TTH extends plainTime;
   /**
    * 7 bit truncated time (only multiple of 15 minutes), 00:00 - 24:00
    * (minutes div 15 + hour * 4 as integer).
    */
   @divisor(15)
-  @encode("", num.BI0_7)
+  @encode("", Num.BI0_7)
   scalar TTQ extends plainTime;
 }
 
-/** All known base data types. */
-// // union types {
-//   alias BI0 = num.BI0;
-//   alias BI1 = num.BI1;
-//   alias BI2 = num.BI2;
-//   alias BI3 = num.BI3;
-//   alias BI4 = num.BI4;
-//   alias BI5 = num.BI5;
-//   alias BI6 = num.BI6;
-//   alias BI7 = num.BI7;
-//   alias BI0_7 = num.BI0_7;
-//   alias UCH = num.UCH;
-//   alias SCH = num.SCH;
-//   alias D1B = num.D1B;
-//   alias BCD = num.BCD;
-//   alias HCD = num.HCD;
-//   alias D1C = num.D1C;
-//   alias PIN = num.PIN;
-//   alias UIN = num.UIN;
-//   alias UIR = num.UIR;
-//   alias SIN = num.SIN;
-//   alias SIR = num.SIR;
-//   alias HCD2 = num.HCD2;
-//   alias D2B = num.D2B;
-//   alias D2C = num.D2C;
-//   alias FLT = num.FLT;
-//   alias FLR = num.FLR;
-//   alias BCD3 = num.BCD3;
-//   alias HCD3 = num.HCD3;
-//   alias ULG = num.ULG;
-//   alias ULR = num.ULR;
-//   alias SLG = num.SLG;
-//   alias SLR = num.SLR;
-//   alias BCD4 = num.BCD4;
-//   alias HCD4 = num.HCD4;
-//   alias EXP = num.EXP;
-//   alias EXR = num.EXR;
-//   alias STR = str.STR;
-//   alias NTS = str.NTS;
-//   alias IGN = str.IGN;
-//   alias HEX = str.HEX;
-//   alias BDY = dtm.BDY;
-//   alias HDY = dtm.HDY;
-//   alias BDA = dtm.BDA;
-//   alias BDA4 = dtm.BDA4;
-//   alias BDA3 = dtm.BDA3;
-//   alias BDZ = dtm.BDZ;
-//   alias HDA = dtm.HDA;
-//   alias HDA4 = dtm.HDA4;
-//   alias HDA3 = dtm.HDA3;
-//   alias DAY = dtm.DAY;
-//   alias DTM = dtm.DTM;
-//   alias BTI = dtm.BTI;
-//   alias HTI = dtm.HTI;
-//   alias VTI = dtm.VTI;
-//   alias BTM = dtm.BTM;
-//   alias VTM = dtm.VTM;
-//   alias HTM = dtm.HTM;
-//   alias MIN = dtm.MIN;
-//   alias TTM = dtm.TTM;
-//   alias TTH = dtm.TTH;
-//   alias TTQ = dtm.TTQ;
-// // }
+// /** All known base data types. */
+// namespace All {
+//   alias BI0 = Num.BI0;
+//   alias BI1 = Num.BI1;
+//   alias BI2 = Num.BI2;
+//   alias BI3 = Num.BI3;
+//   alias BI4 = Num.BI4;
+//   alias BI5 = Num.BI5;
+//   alias BI6 = Num.BI6;
+//   alias BI7 = Num.BI7;
+//   alias BI0_7 = Num.BI0_7;
+//   alias UCH = Num.UCH;
+//   alias SCH = Num.SCH;
+//   alias D1B = Num.D1B;
+//   alias BCD = Num.BCD;
+//   alias HCD = Num.HCD;
+//   alias D1C = Num.D1C;
+//   alias PIN = Num.PIN;
+//   alias UIN = Num.UIN;
+//   alias UIR = Num.UIR;
+//   alias SIN = Num.SIN;
+//   alias SIR = Num.SIR;
+//   alias HCD2 = Num.HCD2;
+//   alias D2B = Num.D2B;
+//   alias D2C = Num.D2C;
+//   alias FLT = Num.FLT;
+//   alias FLR = Num.FLR;
+//   alias BCD3 = Num.BCD3;
+//   alias HCD3 = Num.HCD3;
+//   alias ULG = Num.ULG;
+//   alias ULR = Num.ULR;
+//   alias SLG = Num.SLG;
+//   alias SLR = Num.SLR;
+//   alias BCD4 = Num.BCD4;
+//   alias HCD4 = Num.HCD4;
+//   alias EXP = Num.EXP;
+//   alias EXR = Num.EXR;
+//   alias STR = Str.STR;
+//   alias NTS = Str.NTS;
+//   alias IGN = Str.IGN;
+//   alias HEX = Str.HEX;
+//   alias BDY = Dtm.BDY;
+//   alias HDY = Dtm.HDY;
+//   alias BDA = Dtm.BDA;
+//   alias BDA4 = Dtm.BDA4;
+//   alias BDA3 = Dtm.BDA3;
+//   alias BDZ = Dtm.BDZ;
+//   alias HDA = Dtm.HDA;
+//   alias HDA4 = Dtm.HDA4;
+//   alias HDA3 = Dtm.HDA3;
+//   alias DAY = Dtm.DAY;
+//   alias DTM = Dtm.DTM;
+//   alias BTI = Dtm.BTI;
+//   alias HTI = Dtm.HTI;
+//   alias VTI = Dtm.VTI;
+//   alias BTM = Dtm.BTM;
+//   alias VTM = Dtm.VTM;
+//   alias HTM = Dtm.HTM;
+//   alias MIN = Dtm.MIN;
+//   alias TTM = Dtm.TTM;
+//   alias TTH = Dtm.TTH;
+//   alias TTQ = Dtm.TTQ;
+// }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ebusd/ebus-typespec",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "author": "John Baier",
   "description": "TypeSpec library for defining eBUS messages and emitting to ebusd CSV.",
   "homepage": "https://github.com/john30/ebus-typespec",
@@ -46,6 +46,7 @@
     "@typespec/compiler": "~0.57.0"
   },
   "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
     "@typespec/compiler": "~0.57.0",
     "@typespec/library-linter": "~0.57.0",
     "@typespec/tspd": "latest",
@@ -54,6 +55,9 @@
     "typedoc-plugin-markdown": "^4.1.0",
     "typescript": "^5.4.5"
   },
+  "dependencies": {
+    "js-yaml": "^4.1.0"
+  },
   "scripts": {
     "build": "tsc && npm run build:tsp",
     "watch": "tsc --watch",