@zimo-elektronik/zcan 1.0.0

package/dist/zcan/vehicleGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vehicleGroup.js","sourceRoot":"","sources":["../../src/zcan/vehicleGroup.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,OAAO,EAAC,MAAM,MAAM,CAAC;AAQ7B,OAAO,EAGL,gBAAgB,GAIjB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,wBAAwB,EACxB,aAAa,EACb,UAAU,GACX,MAAM,wBAAwB,CAAC;AAMhC,MAAM,CAAC,OAAO,OAAO,YAAY;IACvB,IAAI,CAAO;IAEH,cAAc,GAAG,IAAI,OAAO,EAAoB,CAAC;IACjD,aAAa,GAAG,IAAI,OAAO,EAAmB,CAAC;IAC/C,aAAa,GAAG,IAAI,OAAO,EAAoB,CAAC;IAChD,cAAc,GAAG,IAAI,OAAO,EAAoB,CAAC;IACjD,qBAAqB,GACnC,IAAI,OAAO,EAA2B,CAAC;IAEzC,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,WAAW,CAAC,cAAsB;QAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC,CAAC,CAAC,CAAC;IACvE,CAAC;IAED,WAAW,CACT,cAAsB,EACtB,SAAiB,EACjB,OAAgB,EAChB,QAAoB,EACpB,aAAuB;QAEvB,MAAM,iBAAiB,GAAG,wBAAwB,CAChD,SAAS,EACT,OAAO,EACP,QAAQ,EACR,aAAa,CACd,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE;YAC7B,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC;YAClC,EAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,EAAC;YACrC,EAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAC;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,YAAY,CACV,cAAsB,EACtB,UAAkB,EAClB,cAAuB;QAEvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE;YAC7B,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC;YAClC,EAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,EAAC;YAC9B,EAAC,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,EAAC;SAC3C,CAAC,CAAC;IACL,CAAC;IAED,qBAAqB,CACnB,cAAsB,EACtB,mBAAwC,EACxC,qBAAmE;QAEnE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE;YAC7B,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC;YAClC,EAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,CAAC,EAAC;YACvC,EAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,CAAC,EAAC;SAC1C,CAAC,CAAC;IACL,CAAC;IAGD,YAAY,CAAC,cAAsB;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CACvB,IAAI,EACJ,IAAI,EACJ,CAAC,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC,CAAC,EACpC,IAAI,CACL,CAAC;IACJ,CAAC;IAGD,eAAe,CAAC,cAAsB;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CACvB,IAAI,EACJ,IAAI,EACJ;YACE,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC;YAClC,EAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAC;SACzB,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,cAAsB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CACvB,IAAI,EACJ,IAAI,EACJ;YACE,EAAC,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,EAAC;YAClC,EAAC,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAC;SACzB,EACD,IAAI,CACL,CAAC;IACJ,CAAC;IAED,KAAK,CACH,IAAY,EACZ,OAAe,EACf,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,IAAI;gBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAChD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAChD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBACnD,MAAM;YACR,KAAK,IAAI;gBACP,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;gBAC1D,MAAM;QACV,CAAC;IACH,CAAC;IAGO,iBAAiB,CACvB,IAAY,EACZ,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACxC,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAE1C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;gBACvB,GAAG,EAAE,GAAG;gBACR,QAAQ;gBACR,UAAU;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAGO,gBAAgB,CACtB,IAAY,EACZ,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAElC,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;YAC9C,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YAExC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;gBACtB,GAAG,EAAE,GAAG;gBACR,UAAU;gBACV,aAAa;gBACb,KAAK;gBACL,KAAK;aACN,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAGO,iBAAiB,CACvB,IAAY,EACZ,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,iBAAiB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACjD,MAAM,OAAO,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAEpC,MAAM,EAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAC,GACjD,UAAU,CAAC,iBAAiB,CAAC,CAAC;YAEhC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;gBACtB,GAAG,EAAE,GAAG;gBACR,OAAO;gBACP,SAAS;gBACT,OAAO;gBACP,QAAQ;gBACR,aAAa;aACd,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAGO,oBAAoB,CAC1B,IAAY,EACZ,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAC9C,MAAM,aAAa,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAE7C,MAAM,cAAc,GAAG,aAAa,KAAK,IAAI,CAAC;YAE9C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;gBACvB,GAAG,EAAE,GAAG;gBACR,cAAc;gBACd,aAAa,EAAE,cAAc;aAC9B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAGO,2BAA2B,CACjC,IAAY,EACZ,IAAY,EACZ,GAAW,EACX,MAAc;QAEd,IAAI,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,CAAC;YACxC,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,mBAAmB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACnD,MAAM,oBAAoB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YAEpD,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC;gBAC9B,GAAG,EAAE,GAAG;gBACR,mBAAmB;gBACnB,oBAAoB;aACrB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF"}

package/dist/zcan/zimoProgrammableScriptGroup.d.ts

@@ -0,0 +1,7 @@
+import MX10 from '../MX10';
+import { Buffer } from 'buffer';
+export default class ZimoProgrammableScriptGroup {
+    private mx10;
+    constructor(mx10: MX10);
+    parse(size: number, command: number, mode: number, nid: number, buffer: Buffer): void;
+}

package/dist/zcan/zimoProgrammableScriptGroup.js

@@ -0,0 +1,9 @@
+export default class ZimoProgrammableScriptGroup {
+    mx10;
+    constructor(mx10) {
+        this.mx10 = mx10;
+    }
+    parse(size, command, mode, nid, buffer) {
+    }
+}
+//# sourceMappingURL=zimoProgrammableScriptGroup.js.map

package/dist/zcan/zimoProgrammableScriptGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zimoProgrammableScriptGroup.js","sourceRoot":"","sources":["../../src/zcan/zimoProgrammableScriptGroup.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,OAAO,2BAA2B;IACtC,IAAI,CAAO;IAEnB,YAAY,IAAU;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CACH,IAAY,EACZ,OAAe,EACf,IAAY,EACZ,GAAW,EACX,MAAc;IAGhB,CAAC;CACF"}

package/gulpfile.js

@@ -0,0 +1,37 @@
+'use strict';
+
+import gulp from 'gulp';
+import typedoc from 'gulp-typedoc';
+import {spawn} from 'child_process';
+import {deleteAsync} from 'del';
+import {resolve} from 'node:path';
+
+const docsPath = './protocol_docs/';
+
+gulp.task('protocol-docs', () => {
+  const isWin = process.platform === 'win32';
+  const cmd = isWin ? '.cmd' : '';
+  let path = resolve(docsPath, 'node_modules', '.bin', 'docusaurus' + cmd);
+
+  return spawn(path, ['build'], {
+    cwd: docsPath,
+    stdio: 'inherit',
+  });
+});
+
+gulp.task('library-docs', () => {
+  return gulp.src(['src/docs_entrypoint.ts']).pipe(
+    typedoc({
+      out: `${docsPath}build/typedoc/`,
+    }),
+  );
+});
+
+gulp.task('clean-protocol', () => {
+  return deleteAsync([`${docsPath}build`]);
+});
+
+gulp.task(
+  'documentation',
+  gulp.series('clean-protocol', 'protocol-docs', 'library-docs'),
+);

package/jest.config.js

@@ -0,0 +1,26 @@
+const isCI = process.env.CI === 'true'
+
+export default {
+  verbose: true,
+  collectCoverage: false,
+  resetModules: true,
+  restoreMocks: true,
+  testEnvironment: 'node',
+  transform: {},
+  preset: 'ts-jest/presets/default-esm',
+  extensionsToTreatAsEsm: ['.ts'],
+  testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+  globals: {
+    'ts-jest': {
+      tsconfig: './tsconfig.test.json',
+      useESM: true,
+    },
+  },
+  collectCoverageFrom: ['<rootDir>/src/*.ts', '<rootDir>/src/zcan/*.ts', '<rootDir>/src/util/speedUtils.ts'],
+  coveragePathIgnorePatterns: ['<rootDir>/dist/', '/node_modules/', '<rootDir>/scripts', '<rootDir>/tools'],
+  coverageProvider: 'v8',
+  coverageReporters: isCI ? ['json'] : ['text'],
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@zimo-elektronik/zcan",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "repository": "https://github.com/ZIMO-Elektronik/zcan",
+  "version": "1.0.0",
+  "scripts": {
+    "start": "node dist/main.js",
+    "start:dev": "nodemon --ext js,ts,json,env --exec \"node --experimental-specifier-resolution=node --loader ts-node/esm\" src/main.ts",
+    "build": "tsc --project tsconfig.build.json",
+    "build:clean": "rm -rf tsconfig.build.tsbuildinfo && rm -rf ./dist",
+    "test": "jest --forceExit",
+    "test:coverage": "npm run test -- --coverage",
+    "test:ci": "npm run test -- --colors --coverage --ci",
+    "lint": "eslint --ext=.ts,.js .",
+    "format": "prettier \"./**\" --write --ignore-unknown",
+    "format:check": "prettier \"./**\" --ignore-unknown --check",
+    "docs": "gulp documentation"
+  },
+  "dependencies": {
+    "rxjs": "^7.8.1",
+    "tslib": "^2.7.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@jest/types": "^29.6.3",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^20.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.8.1",
+    "@typescript-eslint/parser": "^8.8.1",
+    "cross-env": "^7.0.3",
+    "del": "^8.0.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-tsdoc": "^0.3.0",
+    "gulp": "^5.0.0",
+    "gulp-spawn": "^2.0.0",
+    "gulp-typedoc": "git+https://github.com/crutchcorn/gulp-typedoc.git",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.7",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.26.8",
+    "typescript": "5.5.4"
+  }
+}

package/protocol_docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

package/protocol_docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

package/protocol_docs/docs/command-groups/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Commands",
+  "position": 1
+}

package/protocol_docs/docs/command-groups/accessories/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Accessories",
+  "position": 2
+}

package/protocol_docs/docs/command-groups/accessories/accessory-state.md

@@ -0,0 +1,7 @@
+---
+id: accessory-state
+title: Accessory
+sidebar_position: 0
+---
+
+The Command Group 0x01 summarizes the accessory commands. Any stationary device is considered to be an accessory starting with simple turnout decoders or S88 feedbacks up to complex modules with RailCom/mfx receivers

package/protocol_docs/docs/command-groups/command-groups.md

@@ -0,0 +1,50 @@
+---
+id: command-groups
+title: Commands
+sidebar_position: 0
+---
+
+## Receiving and sending commands
+
+There are a few things to watch out for when receiving and sending orders. First, this is what the received message will look like. Also when sending, the message must be in the same format as the received message and the mode will be **0b01**.
+
+| Size   | Unused | Group | Cmd + Mode                                | NID    | Data        |
+|--------|--------|-------|-------------------------------------------|--------|-------------|
+| 16 Bit | 16 Bit | 8 Bit | 8 Bitfirst half = cmd  second half = mode | 16 Bit | 0 ... x Bit |
+
+
+:::note
+
+In every group the 'Data' section is used for further parsing of information! <br/> When receiving the message everything will be in byte version! <br/> When creating the message everything has to be changed to byte version!
+
+:::
+
+## Command group table
+
+Every message contains group code for better handling of commands. All commands are grouped in the following groups:
+
+| Group                                                       | Code | Use/Content                                                                                               |
+|-------------------------------------------------------------|------|-----------------------------------------------------------------------------------------------------------|
+| System                                                      | 0x00 | System critical tasks (on/off, emergency stop, ...)                                                       |
+| Accessories                                                 | 0x01 | Commands for controlling the accessories.                                                                 |
+| This refers to both encoders/feedback devices and decoders. |      |                                                                                                           |
+| Vehicles                                                    | 0x02 | Commands for controlling the vehicles (Mobile Decoder)                                                    |
+| Free                                                        | 0x03 | Currently still unused                                                                                    |
+| GBS                                                         | 0x04 | Telegrams for track diagram control panels                                                                |
+| Train control                                               | 0x05 | Configuration of devices, ZIMO Command Language                                                           |
+| Track config                                                | 0x16 | Configuration of 'Track' accessories                                                                      |
+| Data                                                        | 0x07 | Object data transfer                                                                                      |
+| Info                                                        | 0x08 | Status messages, mostly unrequested messages                                                              |
+| Free                                                        | 0x09 | May be used by third-party systems as required                                                            |
+| Network                                                     | 0x0A | Network Management, Module Registration, ...                                                              |
+| File Control                                                | 0x0E | E Control commands for file transfer such as: File Open, Close, ...                                       |
+| File Transfer                                               | 0x0F | File 'Contents' (data) Telegrams                                                                          |
+| PC data-grams                                               | 0x0n | To optimize the data throughput between a PC application and the MX10, there are some specific data-grams |
+| Lan Data                                                    | 0x17 | 🚧 Add description                                                                                        |
+| Lan Info                                                    | 0x18 | 🚧 Add description                                                                                        |
+
+:::caution Under construction🚧
+
+Add missing description <br/> Check other descriptions
+
+:::

package/protocol_docs/docs/command-groups/data/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Data",
+  "position": 6
+}

package/protocol_docs/docs/command-groups/data/data-name-extended.md

@@ -0,0 +1,60 @@
+---
+id: data-name-extended
+title: Data Name Extended
+sidebar_position: 7
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="21"/>
+
+## Receiving
+
+This command is only available on the PC interface (USB/LAN). This allows an app to transfer texts with up to 192 characters in one command. However, some entries are limited to 32 characters, or there are limitations in the GUI display.
+
+:::warning
+
+Names and other strings needs to be sent terminated with 0x00
+
+:::
+
+When receiving command _0x21_ the 'Data' section will look like this:
+
+| NID    | Sub ID | Value1 | Value2 | Name      |
+|--------|--------|--------|--------|-----------|
+| 16 Bit | 16 Bit | 32 Bit | 32 Bit | 191 Bytes |
+
+
+The 'NID' indicates for which device the text is valid. If 'NID' is e.g.: the NID of a vehicle, the texts are linked to this vehicle. All other texts can also be transmitted with this command.
+
+### Description table for value 1 / 2
+
+| NID         | Sub ID       | Value1                          | Value2 | Usage                      | Max length    |
+|-------------|--------------|---------------------------------|--------|----------------------------|---------------|
+| Vehicle     | 0            | 0                               | 0      | Vehicle name               | 32 characters |
+|             | 1            | 0                               | 0      | Railroad company           | 32 characters |
+| Accessories | Port         | 0                               | 0      | Designation for connection |               |
+| 0x7F00      | Vendor       | 0                               | 0      | Manufacturer names         | 32 characters |
+| 0x7F02      | Decoder      | 0                               | 0      | Decoder name/types         | 32 characters |
+| 0x7F04      | CfgName      | Type (8Bit)<br/> CgfNum (24Bit) | 0      | CV Designation             | 32 characters |
+| 0x7F06      | Cfg Db       |                                 |        | Cfg Db                     | 32 characters |
+| 0x7F10      | Icon         |                                 |        | Icon                       | 32 characters |
+| 0x7F11      | Icon         |                                 |        | Icon                       | 32 characters |
+| 0x7F18      | ZIMO Partner |                                 |        | ZIMO Partner               | 32 characters |
+| 0x7F20      | Land         |                                 |        | Land                       | 32 characters |
+
+
+:::info
+
+Value2 is intended for groups.
+
+:::
+
+## Sending
+
+When sending command _0x21_ the 'Data' section will look like this:
+
+| NID    | Sub ID | 0      | 0      | Name                | 0     |
+|--------|--------|--------|--------|---------------------|-------|
+| 16 Bit | 16 Bit | 32 Bit | 32 Bit | Name length * 8 Bit | 8 Bit |
+

package/protocol_docs/docs/command-groups/data/group-count.md

@@ -0,0 +1,52 @@
+---
+id: group-count
+title: Group Count
+sidebar_position: 1
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="00"/>
+
+## Receiving
+
+When receiving command _0x00_ the 'Data' section will look like this:
+
+| Object type | Number |
+|-------------|--------|
+| 16 Bit      | 16 Bit |
+
+
+By Mode = 0b00 a device can query if the MX10 knows a certain device group (Object type). The MX10 responds (Mode = 0b11) with group and the known number of devices in the respective group.
+
+:::note
+
+Group Count for MX8, MX9 modules returns with unknown count (e.g. because request too early, auto-scan off, feedback error is present,...) the result is 0xFFFF.
+
+:::
+
+### Object type codes
+
+| Object type | Description                      |
+|-------------|----------------------------------|
+| 0x0000      | Vehicles                         |
+| 0x2F00      | Trains                           |
+| 0x3000      | Accessories, DCC 'simple'        |
+| 0x3200      | DCC 'eXtended' accessory decoder |
+| 0x5040      | MX8 Module                       |
+| 0x5080      | MX9 Module                       |
+
+
+## Sending
+
+When sending command _0x00_ the 'Data' section will look like this:
+
+| NID    | Object type |
+|--------|-------------|
+| 16 Bit | 16 Bit      |
+
+:::note
+
+Mode should be set to 0b00.
+
+:::

package/protocol_docs/docs/command-groups/data/item-fx-info.md

@@ -0,0 +1,27 @@
+---
+id: item-fx-info
+title: Item Fx Info
+sidebar_position: 6
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="15"/>
+
+## Receiving
+
+When receiving command _0x15_ the 'Data' section will look like this:
+
+| NID    | Fx     | Unused | Type  | Data   |
+|--------|--------|--------|-------|--------|
+| 16 Bit | 16 Bit | 8 Bit  | 8 Bit | 16 Bit |
+
+
+## Sending
+
+When sending command _0x15_ the 'Data' section will look like this:
+
+| NID    | Fx     | 0     | Type  | Data   |
+|--------|--------|-------|-------|--------|
+| 16 Bit | 16 Bit | 8 Bit | 8 Bit | 16 Bit |
+

package/protocol_docs/docs/command-groups/data/item-image-config.md

@@ -0,0 +1,44 @@
+---
+id: item-image-config
+title: Item Image Config
+sidebar_position: 5
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="12"/>
+
+## Receiving
+
+With the 'Data Image Config' data-grams the images can be transferred for each vehicle, accessory, device in the system.
+
+When receiving command _0x12_ the 'Data' section will look like this:
+
+| NID    | Type   | Image ID |
+|--------|--------|----------|
+| 16 Bit | 16 Bit | 16 Bit   |
+
+:::tip
+
+Vehicle images can also be retrieved or specified by ImageCRC32, the conversion to the ImageID must be calculated in the be calculated in the respective device. The 'source' for the ImageCRC32 is always the 'big' vehicle image (279x92 pixel, 16 (if MX32/FU calculated) or 24 (if PC calculated) bit colors).
+
+:::
+
+### Image Types
+
+| Type | Description                   |
+|------|-------------------------------|
+| 0x01 | Vehicle image: Image ID       |
+| 0x02 | Vehicle image: Image CRC32    |
+| 0x03 | Vehicle speedometer: Image ID |
+| 0x04 | 🚧                            |
+| 0x10 | Vehicle Instrument: Brake Bar |
+| 0x1f | Vehicle instrument            |
+
+## Sending
+
+When sending command _0x12_ the 'Data' section will look like this:
+
+| NID    | Type   | Image ID |
+|--------|--------|----------|
+| 16 Bit | 16 Bit | 16 Bit   |

package/protocol_docs/docs/command-groups/data/item-list-by-index.md

@@ -0,0 +1,45 @@
+---
+id: item-list-by-index
+title: Item List By Index
+sidebar_position: 2
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="01"/>
+
+## Receiving
+
+When receiving command _0x01_ the 'Data' section will look like this:
+
+| Index  | Device NID | Last tick (ms) |
+|--------|------------|----------------|
+| 16 Bit | 16 Bit     | 16 Bit         |
+
+
+By Mode = 0b00 a device can query the object list via the object index in the MX10. The MX10 responds (Mode = 0b11) with the object index and the NID of the object. This allows a device to build up a list of objects known to the MX10.
+
+Case 1: Device present <br/>If there is an object in the MX10 under the requested index, it returns the index, the NId of the device and the number of mS since the last communication with the device. <br/>Case 2: Device not present/unknown <br/>If the MX10 does not know a device under the given index, it returns the requested index in the response, as NId=0xFFFF and also as last communication tick 0xFFFF.
+
+Likewise, if the index is outside the 'object group' (e.g.: for MX8/MX9 only indexes from 0 ... 63 are allowed), device is unknown.
+
+:::note
+
+With this command a 'direct' memory access is performed. The object may or may not contain data (object). If a query on index e.g.: index 10 returns 'no data', then there may be some on Index 11.The response (M = 0b11) contains the 'next' NId, the corresponding index and, if available, the last 'communication bar'.
+
+:::
+
+## Sending
+
+When sending command _0x01_ the 'Data' section will look like this:
+
+| NID    | Group NID | Index  |
+|--------|-----------|--------|
+| 16 Bit | 16 Bit    | 16 Bit |
+
+
+:::note
+
+Mode should be set to 0b00.
+
+:::

package/protocol_docs/docs/command-groups/data/item-list-by-nid.md

@@ -0,0 +1,43 @@
+---
+id: item-list-by-nid
+title: Item List By NID
+sidebar_position: 3
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="02"/>
+
+## Receiving
+
+When receiving command _0x02_ the 'Data' section will look like this:
+
+| NID    | Index  | Item state | Last tick (ms) |
+|--------|--------|------------|----------------|
+| 16 Bit | 16 Bit | 16 Bit     | 16 Bit         |
+
+
+By Mode = 0b00 a device can query that NId which is stored after the specified NId. This command is especially helpful for accessory modules/decoders. The answer (Mode = 0b11) contains the 'next' NId, the respective index and if available the last 'communication tick'. Similar to 'Item List by Index' [0x07.0x01] there are 2 possible answers:
+
+1. The MX10 finds a 'next' device after the given NId in the same object group. In this case it returns the found NId, the index and the last communication tick.
+2. The MX10 does not know any other devices in the object group, the NId refers to an unknown object group, ... In this case the MX10 finds a 'next' device after the given NId. In this case the MX10 answers with NId=0xFFFF, Index=0xFFFF and LastTick=0xFFFF.
+
+:::note
+
+MX10 will return 'yes' answers if it finds more data and empty memory locations are skipped. The response (M = 0b11) contains the 'next' NId, the corresponding index and, if available, the last 'communication bar'.
+
+:::
+
+## Sending
+
+When sending command _0x02_ the 'Data' section will look like this:
+
+| NID    | Search after value |
+|--------|--------------------|
+| 16 Bit | 16 Bit             |
+
+:::note
+
+Mode should be set to 0b00.
+
+:::

package/protocol_docs/docs/command-groups/data/remove-train.md

@@ -0,0 +1,33 @@
+---
+id: remove-train
+title: Remove Train
+description: 0x07.0x1f
+sidebar_position: 4
+---
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="07" command="1f"/>
+
+## Receiving 
+
+When receiving command the 'Data' section will look like this:
+
+| NID    | State  |
+|--------|--------|
+| 16 Bit | 16 Bit |
+
+
+## Sending
+
+When sending command the 'Data' section will look like this:
+
+| Remove from device with NID | NID of locomotive (or other device) to remove |
+|-----------------------------|-----------------------------------------------|
+| 16 Bit                      | 16 Bit                                        |
+
+
+:::note
+
+'Remove from NID' specifies which device should remove the train.
+
+:::

package/protocol_docs/docs/command-groups/info/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Info",
+  "position": 7
+}

package/protocol_docs/docs/command-groups/info/bidi-info.md

@@ -0,0 +1,34 @@
+---
+id: bidi-info
+title: BiDi Info
+sidebar_position: 1
+---
+
+import CommandAndGroup from '@site/src/components/CommandAndGroup';
+
+<CommandAndGroup group="08" command="05"/>
+
+## Receiving
+
+When receiving command _0x05_ the 'Data' section will look like this:
+
+| NID    | Type   | Data   |
+|--------|--------|--------|
+| 16 Bit | 16 Bit | 32 Bit |
+
+
+With this data-gram the MX10 BiDi reports information The 'NID' indicates which device should answer the question. Typically this is the NID of the the PC is connected to. However, especially in a network, it can also be another device (e.g.: Tab, another PC).
+
+### Type table
+
+| Type   | Description        |
+|--------|--------------------|
+| 0x0100 | BiDi Speed         |
+| 0x0101 | Tilt/Curve         |
+| 0x0200 | BiDi CV            |
+| 0x0300 | BiDi QoS           |
+| 0x0400 | BiDi Fill level    |
+| 0x0800 | BiDi Direction     |
+| 0x1000 | BiDi Track Voltage |
+| 0x1100 | BiDi Alarms        |
+

package/protocol_docs/docs/command-groups/lan-data/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Lan Data",
+  "position": 9
+}