From 9f5aad89d71a0d6afef18d3a1820b458aaeb9ada Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 31 Aug 2022 07:10:22 -0700 Subject: [PATCH] Trying sections --- .gencode_hash.txt | 45 +++++++------ bin/gencode_docs | 10 +-- etc/schema_categories.txt | 7 --- etc/schema_navbar.html | 1 + gencode/docs/cloud_iot_config.html | 2 +- gencode/docs/command_discovery.html | 4 +- gencode/docs/command_mapping.html | 10 +-- gencode/docs/config.html | 22 +++---- gencode/docs/config_mapping.html | 10 +-- gencode/docs/config_pointset.html | 4 +- gencode/docs/configuration_endpoint.html | 4 +- gencode/docs/configuration_pubber.html | 2 +- gencode/docs/envelope.html | 2 +- gencode/docs/event.html | 52 +++++++-------- gencode/docs/event_discovery.html | 36 +++++------ gencode/docs/event_mapping.html | 10 +-- gencode/docs/event_pointset.html | 10 +-- gencode/docs/event_system.html | 10 +-- gencode/docs/event_validation.html | 16 ++--- gencode/docs/metadata.html | 30 ++++----- gencode/docs/model_pointset.html | 4 +- gencode/docs/properties.html | 2 +- gencode/docs/readme.md | 12 ++-- gencode/docs/reflect_config.html | 4 +- gencode/docs/reflect_state.html | 4 +- gencode/docs/state.html | 80 ++++++++++++------------ gencode/docs/state_mapping.html | 10 +-- gencode/docs/state_pointset.html | 4 +- gencode/docs/state_validation.html | 16 ++--- schema/envelope.json | 1 + 30 files changed, 213 insertions(+), 211 deletions(-) delete mode 100644 etc/schema_categories.txt diff --git a/.gencode_hash.txt b/.gencode_hash.txt index 05599a628d..2dc782d8c6 100644 --- a/.gencode_hash.txt +++ b/.gencode_hash.txt @@ -1,26 +1,31 @@ -52e5e736587cb4d9615b5b48dda53d385fb4c7091864e5d7ebaf804a46519852 gencode/docs/cloud_iot_config.html -36842bbf9d023a83a3e8958fc3ae607424f4ada5b1e72be35fe2ac443cfd31cc gencode/docs/command_discovery.html -4d65d7043d4e37e7f043a3e6d4d859bc84cf6ed1c5a07d9f04b731ee9e6b16ef gencode/docs/command_mapping.html -d755727827955c38c6679869a4e9177e44a83770a1c6a046f953954792a6d4a4 gencode/docs/config.html -6cffb39b5071680f39a7b96bdeb8330b6a8f5fa71ed4c4d42b82d7896080dcd9 gencode/docs/config_mapping.html -62a5f579661625c0fa53320557be47711e289566b14bd0399b45395cea87ae27 gencode/docs/config_pointset.html -34e05b6966c611afd4591bdb2f1a606123326c922b0747a3b0861383d68c1177 gencode/docs/configuration_endpoint.html -01ee911c3d85ce9d5de98a77d15a78e7719bc151efdf5149082c8056b7a60bc1 gencode/docs/envelope.html -b8972d7b07d1dc6bdb82988e1e9955603a80477cac18e7745ecbd7fe78c104ba gencode/docs/event_discovery.html -971c2d352004e53c8fe4fa9370685dca8ed974a97b2e1e2382653be344010346 gencode/docs/event_mapping.html -8133e380e40f27c56accbffc665b2eeb56ec84a4da3b52ba7aa5e439c9c40572 gencode/docs/event_pointset.html -ac05c443556b92de96ec1867e72c668da27bc53012fe5821a8035a81ed46aaaf gencode/docs/event_system.html -51cc24f8ebe5daa9f165ec401cf4745994823037ba6a0753730339ef81a57fa6 gencode/docs/event_validation.html -469909f7061efeaed0942e3aad43468e56dbeb335c664412c976d9f1e4bc44c9 gencode/docs/index.html -6d5081d04c86f8bd444efb41cd788826aa66802d37e8f98e93b6b75425542d5e gencode/docs/metadata.html -a5263284652e52822c82a863fc27db765eb55861f96316f07836619376323bce gencode/docs/model_pointset.html +909b90e19ba41e691ea277eb26ff8a3b7d7bad43ecd7ac082683e97401bde9b5 gencode/docs/cloud_iot_config.html +b35646a2f3d7c30fd34e3ea6ab6a1070b39c469fd1de49cab1093ff32faaf06d gencode/docs/command_discovery.html +2fa3a4fbe63db1368214f1bbdbd5260d6a424beb0b14771ff270e2d11b3e6e0f gencode/docs/command_mapping.html +d93322f64b94bc1808c59cde7b83915ff7e14d50401b9c2ae8467730ed15257c gencode/docs/config.html +51db3553042487f9b48dc130affa5deb01636313e0a9aaca12c76cb6865deaa6 gencode/docs/config_mapping.html +cd75720e16801366f0f77b1c641de91c44b713ac053211a816226fd555b40734 gencode/docs/config_pointset.html +c6eb01ffc4da3b88f8130d5ee6559afee9fec88b530b9d57ccfa7e7a354b3ed7 gencode/docs/configuration_endpoint.html +299bc6f4d9842fab2d2cfd003d8a8adf94303c560cf71e8595d85cf661558a4d gencode/docs/configuration_pubber.html +82fbf41e4e88593f22a929fc8ade4d1e8f75a0fc1aa8452ea1d3b19023bee314 gencode/docs/envelope.html +76cd3d4f0d893646afb910c51eed3783b9d50abf75955d1bc20411fc6d738674 gencode/docs/event.html +0c829f15eba3d1b5c26b5cbef2ff42ed5ffec4adf60797ce137c1662e97c47e6 gencode/docs/event_discovery.html +885c20247cdce702362939277d5b0604c437ca71cad1e66566fb24818f46af6a gencode/docs/event_mapping.html +71fe25d3b17d1dc87b52c049a3235c20527f73e12ffa53fa4800a15e53f73732 gencode/docs/event_pointset.html +8a48d7f06bebc571b3dba1487680565b9cda838bf68c60422a7632f6ee3d830c gencode/docs/event_system.html +2c695f6891655fa7b2b2a48fbb8503e049384bd6015f4d40f618d151c71b1a22 gencode/docs/event_validation.html +208956129b09bde2639068b0bb3282dce09b12edb5e775eeed0834fa4890a001 gencode/docs/metadata.html +8111fcce3221fca66361d3d3c4ef7417aaaa44d3a8f295e24fe958e719f79666 gencode/docs/model_pointset.html +5d039d607af9ec75ee552dfe36b16c702687ea16f5663f41fc49b4533b86e00d gencode/docs/properties.html +dc7c5008064b2b3f8ca6ab456b0d3dd9ab661b1ee5937f8b4edcbe99f5c22585 gencode/docs/readme.md +690d56e96c4e180e49e0abcba358ab1842ea06dd3f693918852a9de370c994d5 gencode/docs/reflect_config.html +9332e44c87dae9261b079424e748d5ee1df08a3c6b39987d254ebf78274e2f34 gencode/docs/reflect_state.html 741b880216be3743f6747800a042f2dbd89f3b0344c6b0a965f4bc010f03a930 gencode/docs/schema_doc.css 878ea88206c974f40643c3cc430875f9c4e8c5e3fd6bcd6358bd3eb6d48699a9 gencode/docs/schema_doc.min.js 7ed934930aee763e0beebc349725ba3909115e8d346bb762f28bcbe745bb163a gencode/docs/schema_extras.js -7dab133dd7e23d2b61b325516a274be5007ae9fc739ced3d244bb05ba0dac648 gencode/docs/state.html -053656d21797603350e92d836e8d6cdcab6733e8c20d2ae47db5cc14bc3a61e5 gencode/docs/state_mapping.html -b0c4bf203dd8ea482d0d6b7ec9549bd8ddf597faf7afdc410351e527f4cc68b1 gencode/docs/state_pointset.html -f680b255d4b185cc96347a2c6425bb33c847cf7468d309c33aa7901567cd02b7 gencode/docs/state_validation.html +a5cadd7e1393d79949367ed2b8c6f9afa186936fe408b5db8505ed8dd0bfa800 gencode/docs/state.html +cef4c8fab1405459739e54c90391d67bf48a26e4d72425c63762ecd596b6d0f0 gencode/docs/state_mapping.html +583edd585cdfbf8b2e3940036a235e09755ec1ae2e00d26df017c50ac9b9f489 gencode/docs/state_pointset.html +6aa786392003b64c99a3862700f33f100facff2b2592b87d53e6011a7298f909 gencode/docs/state_validation.html d39d7fe37a41c74a40080af7b0a429d201ab1fdff7444428c4b98eb7b38c332b gencode/java/udmi/schema/Asset.java 0825a5cec83003bb0a6488c4ed7010a04ae0d3848ef36fe01bb4e6718ba7b96d gencode/java/udmi/schema/Aux.java 1f2757c67215cf657297a009a01288108a04daeea919713871a2d34ea903b5f9 gencode/java/udmi/schema/BlobBlobsetConfig.java diff --git a/bin/gencode_docs b/bin/gencode_docs index dcb007a5a0..37c13815b7 100755 --- a/bin/gencode_docs +++ b/bin/gencode_docs @@ -113,13 +113,15 @@ done rm -rf $TMP_DIR +echo Generating schema index page... + # Create index page with links to different schemas cp etc/schema_index.md $OUTPUT_DIR/readme.md for schema in $schemas; do - category=$(grep "^$schema " etc/schema_categories.txt | sed -E 's/^[A-Za-z_.]* (.*)$/\1/g') - if [[ -z $category || $(grep -c "## $category\$" $OUTPUT_DIR/readme.md) -eq 0 ]]; then - category=Other + section=$(jq -r '.["$section"]' schema/$schema.json) + if [[ -z $section || $(grep -c "## $section\$" $OUTPUT_DIR/readme.md) -eq 0 ]]; then + section=Other fi description=$(jq -r .description schema/$schema.json) if [[ $description == null ]]; then @@ -127,7 +129,7 @@ for schema in $schemas; do else description=$(echo " - $description" | sed 's@(\.\./@(\.\./\.\./@g') fi - sed -i "s@## $category@## $category\n* [**$schema**]($schema.html)$description@" $OUTPUT_DIR/readme.md + sed -i "s@## $section@## $section\n* [**$schema**]($schema.html)$description@" $OUTPUT_DIR/readme.md done diff --git a/etc/schema_categories.txt b/etc/schema_categories.txt deleted file mode 100644 index 76eeed3419..0000000000 --- a/etc/schema_categories.txt +++ /dev/null @@ -1,7 +0,0 @@ -event_pointset Messages -event_discovery Messages -state Messages -config Messages -envelope Messages -metadata Site Model -cloud_iot_config Site Model \ No newline at end of file diff --git a/etc/schema_navbar.html b/etc/schema_navbar.html index c1d42880dd..f4ceb3d1ad 100644 --- a/etc/schema_navbar.html +++ b/etc/schema_navbar.html @@ -1,6 +1,7 @@ diff --git a/gencode/docs/cloud_iot_config.html b/gencode/docs/cloud_iot_config.html index e18f8c41db..ae0f0be4ff 100644 --- a/gencode/docs/cloud_iot_config.html +++ b/gencode/docs/cloud_iot_config.html @@ -15,7 +15,7 @@ Cloud Iot Config -

Cloud Iot Config

+

Cloud Iot Config

diff --git a/gencode/docs/command_discovery.html b/gencode/docs/command_discovery.html index 8b1fd3aefe..3130995ff4 100644 --- a/gencode/docs/command_discovery.html +++ b/gencode/docs/command_discovery.html @@ -15,7 +15,7 @@ Discovery Command -

Discovery Command

+

Discovery Command

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
diff --git a/gencode/docs/command_mapping.html b/gencode/docs/command_mapping.html index 581de322a5..41a5613d52 100644 --- a/gencode/docs/command_mapping.html +++ b/gencode/docs/command_mapping.html @@ -15,7 +15,7 @@ Mapping Command -

Mapping Command

+

Mapping Command

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -204,7 +204,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1505,7 +1505,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1550,7 +1550,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/config.html b/gencode/docs/config.html index 59432569c5..4dd6e00a23 100644 --- a/gencode/docs/config.html +++ b/gencode/docs/config.html @@ -15,7 +15,7 @@ Config -

Config

+

Config

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -502,9 +502,9 @@

Each item of this array must be:


Example:
-
[
-    "AHU-22"
-]
+
[
+    "AHU-22"
+]
 
@@ -1220,9 +1220,9 @@


Examples:
-
"bacnet"
+
"bacnet"
 
-
"ipv4"
+
"ipv4"
 
@@ -1277,7 +1277,7 @@


Example:
-
"4148893"
+
"4148893"
 
@@ -1931,7 +1931,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -2282,7 +2282,7 @@


Example:
-
"AI1106"
+
"AI1106"
 
@@ -2396,7 +2396,7 @@


Example:
-
22.4
+
22.4
 
diff --git a/gencode/docs/config_mapping.html b/gencode/docs/config_mapping.html index d04f8bfeac..4df08a02e5 100644 --- a/gencode/docs/config_mapping.html +++ b/gencode/docs/config_mapping.html @@ -15,7 +15,7 @@ Mapping Config -

Mapping Config

+

Mapping Config

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -416,7 +416,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -2123,7 +2123,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -2182,7 +2182,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/config_pointset.html b/gencode/docs/config_pointset.html index 1946c2828e..40d340f5f8 100644 --- a/gencode/docs/config_pointset.html +++ b/gencode/docs/config_pointset.html @@ -14,8 +14,8 @@ Pointset Config - -

Pointset Config

+ +

Pointset Config

diff --git a/gencode/docs/configuration_endpoint.html b/gencode/docs/configuration_endpoint.html index 15230c44fc..52a19f1fdc 100644 --- a/gencode/docs/configuration_endpoint.html +++ b/gencode/docs/configuration_endpoint.html @@ -14,8 +14,8 @@ Endpoint Configuration - -

Endpoint Configuration

+ +

Endpoint Configuration

diff --git a/gencode/docs/configuration_pubber.html b/gencode/docs/configuration_pubber.html index 4fd16eb12c..c2f5442b06 100644 --- a/gencode/docs/configuration_pubber.html +++ b/gencode/docs/configuration_pubber.html @@ -15,7 +15,7 @@ Pubber Configuration -

Pubber Configuration

+

Pubber Configuration

diff --git a/gencode/docs/envelope.html b/gencode/docs/envelope.html index 568c58a983..9189ba7bf2 100644 --- a/gencode/docs/envelope.html +++ b/gencode/docs/envelope.html @@ -15,7 +15,7 @@ Envelope -

Envelope

+

Envelope

diff --git a/gencode/docs/event.html b/gencode/docs/event.html index 855bac4e97..e6b4aa9ec8 100644 --- a/gencode/docs/event.html +++ b/gencode/docs/event.html @@ -15,7 +15,7 @@ Event -

Event

+

Event

@@ -99,7 +99,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -270,7 +270,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1977,7 +1977,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -2036,7 +2036,7 @@


Example:
-
600
+
600
 
@@ -2492,7 +2492,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -2721,11 +2721,11 @@


Examples:
-
24.1
+
24.1
 
-
"running"
+
"running"
 
-
4
+
4
 
@@ -2814,7 +2814,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -2900,7 +2900,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -2990,7 +2990,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -4494,7 +4494,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -4546,7 +4546,7 @@


Example:
-
600
+
600
 
@@ -5423,7 +5423,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -7333,7 +7333,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -7399,7 +7399,7 @@


Example:
-
600
+
600
 
@@ -7707,7 +7707,7 @@


Example:
-
"Google"
+
"Google"
 
@@ -7766,11 +7766,11 @@


Examples:
-
"Pixel 5"
+
"Pixel 5"
 
-
"Pixel 6"
+
"Pixel 6"
 
-
"Pixel 6 Pro"
+
"Pixel 6 Pro"
 
@@ -7829,9 +7829,9 @@


Examples:
-
"GF5KQ"
+
"GF5KQ"
 
-
"4215612"
+
"4215612"
 
@@ -7890,11 +7890,11 @@


Examples:
-
"A"
+
"A"
 
-
"B"
+
"B"
 
-
"1"
+
"1"
 
diff --git a/gencode/docs/event_discovery.html b/gencode/docs/event_discovery.html index 658c466a75..58acdb427e 100644 --- a/gencode/docs/event_discovery.html +++ b/gencode/docs/event_discovery.html @@ -15,7 +15,7 @@ Discovery Event -

Discovery Event

+

Discovery Event

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -132,7 +132,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -208,7 +208,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1509,7 +1509,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1554,7 +1554,7 @@


Example:
-
600
+
600
 
@@ -2312,7 +2312,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -4019,7 +4019,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -4078,7 +4078,7 @@


Example:
-
600
+
600
 
@@ -4344,7 +4344,7 @@


Example:
-
"Google"
+
"Google"
 
@@ -4396,11 +4396,11 @@


Examples:
-
"Pixel 5"
+
"Pixel 5"
 
-
"Pixel 6"
+
"Pixel 6"
 
-
"Pixel 6 Pro"
+
"Pixel 6 Pro"
 
@@ -4452,9 +4452,9 @@


Examples:
-
"GF5KQ"
+
"GF5KQ"
 
-
"4215612"
+
"4215612"
 
@@ -4506,11 +4506,11 @@


Examples:
-
"A"
+
"A"
 
-
"B"
+
"B"
 
-
"1"
+
"1"
 
diff --git a/gencode/docs/event_mapping.html b/gencode/docs/event_mapping.html index 7d68234fd8..64611be65e 100644 --- a/gencode/docs/event_mapping.html +++ b/gencode/docs/event_mapping.html @@ -15,7 +15,7 @@ Mapping Event -

Mapping Event

+

Mapping Event

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -204,7 +204,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1505,7 +1505,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1550,7 +1550,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/event_pointset.html b/gencode/docs/event_pointset.html index 857a004eca..41ecae0d6f 100644 --- a/gencode/docs/event_pointset.html +++ b/gencode/docs/event_pointset.html @@ -15,7 +15,7 @@ Pointset Event -

Pointset Event

+

Pointset Event

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -254,11 +254,11 @@


Examples:
-
24.1
+
24.1
 
-
"running"
+
"running"
 
-
4
+
4
 
diff --git a/gencode/docs/event_system.html b/gencode/docs/event_system.html index 6e431b770d..acb3863f61 100644 --- a/gencode/docs/event_system.html +++ b/gencode/docs/event_system.html @@ -15,7 +15,7 @@ System Event -

System Event

+

System Event

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -203,7 +203,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1707,7 +1707,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1759,7 +1759,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/event_validation.html b/gencode/docs/event_validation.html index ae923ce704..efd4a57d11 100644 --- a/gencode/docs/event_validation.html +++ b/gencode/docs/event_validation.html @@ -15,7 +15,7 @@ Validation Event -

Validation Event

+

Validation Event

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -238,7 +238,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1539,7 +1539,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1584,7 +1584,7 @@


Example:
-
600
+
600
 
@@ -1884,7 +1884,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -3388,7 +3388,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -3440,7 +3440,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html index d0557fd1e4..788f396617 100644 --- a/gencode/docs/metadata.html +++ b/gencode/docs/metadata.html @@ -15,7 +15,7 @@ Metadata -

Metadata

+

Metadata

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -445,7 +445,7 @@


Example:
-
"US-SFO-XYY"
+
"US-SFO-XYY"
 
@@ -1252,7 +1252,7 @@


Example:
-
"GAT-100"
+
"GAT-100"
 
@@ -1373,9 +1373,9 @@

Each item of this array must be:


Example:
-
[
-    "AHU-22"
-]
+
[
+    "AHU-22"
+]
 
@@ -1636,9 +1636,9 @@


Examples:
-
"bacnet"
+
"bacnet"
 
-
"modbus"
+
"modbus"
 
@@ -1693,7 +1693,7 @@


Example:
-
"4148893"
+
"4148893"
 
@@ -2234,7 +2234,7 @@


Example:
-
22
+
22
 
@@ -2293,7 +2293,7 @@


Example:
-
2
+
2
 
@@ -2410,7 +2410,7 @@


Example:
-
1
+
1
 
@@ -2469,9 +2469,9 @@


Examples:
-
"AI3"
+
"AI3"
 
-
"400070"
+
"400070"
 
diff --git a/gencode/docs/model_pointset.html b/gencode/docs/model_pointset.html index 9175018470..da7b830664 100644 --- a/gencode/docs/model_pointset.html +++ b/gencode/docs/model_pointset.html @@ -14,8 +14,8 @@ Pointset Model - -

Pointset Model

+ +

Pointset Model

diff --git a/gencode/docs/properties.html b/gencode/docs/properties.html index f749e94111..4d98cc3f95 100644 --- a/gencode/docs/properties.html +++ b/gencode/docs/properties.html @@ -15,7 +15,7 @@ Properties -

Properties

+

Properties

diff --git a/gencode/docs/readme.md b/gencode/docs/readme.md index e77dfccba1..33e58dda79 100644 --- a/gencode/docs/readme.md +++ b/gencode/docs/readme.md @@ -3,27 +3,27 @@ # UDMI Schema ## Messages -* [**config**](config.html) - The config block controls a device's intended behavior. [Config Documentation](../../docs/messages/config.md) * [**envelope**](envelope.html) - The UDMI `envelope` is not a message itself, per se, but the attributes and other information that is delivered along with a message. [Message Envelope Documentation](../../docs/messages/envelope.md) -* [**event_discovery**](event_discovery.html) - [Discovery result](../../docs/specs/discovery.md) with implicit enumeration -* [**event_pointset**](event_pointset.html) - A set of points reporting telemetry data. [Pointset Event Documentation](../../docs/messages/pointset.md#telemetry) -* [**state**](state.html) - [State](../../docs/messages/state.md) message, defined by [`state.json`] ## Site Model -* [**cloud_iot_config**](cloud_iot_config.html) - Parameters for configuring a connection to cloud systems -* [**metadata**](metadata.html) - [Metadata](../../docs/specs/metadata.md) is a description about the device: a specification about how the device should be configured and expectations about what the device should be doing. Defined by `metadata.json` ## Other +* [**cloud_iot_config**](cloud_iot_config.html) - Parameters for configuring a connection to cloud systems * [**command_discovery**](command_discovery.html) - [Discovery command](../../docs/specs/discovery.md) for provisioning * [**command_mapping**](command_mapping.html) - [Mapping command](../../docs/specs/mapping.md) for provisioning +* [**config**](config.html) - The config block controls a device's intended behavior. [Config Documentation](../../docs/messages/config.md) * [**config_mapping**](config_mapping.html) - Configuration for [mapping](../../docs/specs/mapping.md) * [**configuration_pubber**](configuration_pubber.html) - Parameters to define a pubber runtime instance * [**event**](event.html) - Container object for all event schemas, not directly used. +* [**event_discovery**](event_discovery.html) - [Discovery result](../../docs/specs/discovery.md) with implicit enumeration * [**event_mapping**](event_mapping.html) - [Mapping result](../../docs/specs/mapping.md) with implicit enumeration +* [**event_pointset**](event_pointset.html) - A set of points reporting telemetry data. [Pointset Event Documentation](../../docs/messages/pointset.md#telemetry) * [**event_system**](event_system.html) - Used for system events such as logging. [System Event Documentation](../../docs/messages/system.md#event) * [**event_validation**](event_validation.html) - Validation device result +* [**metadata**](metadata.html) - [Metadata](../../docs/specs/metadata.md) is a description about the device: a specification about how the device should be configured and expectations about what the device should be doing. Defined by `metadata.json` * [**properties**](properties.html) * [**reflect_config**](reflect_config.html) - Config for a reflector client * [**reflect_state**](reflect_state.html) - State of a reflector client +* [**state**](state.html) - [State](../../docs/messages/state.md) message, defined by [`state.json`] * [**state_mapping**](state_mapping.html) - State for [mapping](../../docs/specs/mapping.md) * [**state_validation**](state_validation.html) - Validation state summary diff --git a/gencode/docs/reflect_config.html b/gencode/docs/reflect_config.html index aad09866da..02ce54df43 100644 --- a/gencode/docs/reflect_config.html +++ b/gencode/docs/reflect_config.html @@ -15,7 +15,7 @@ Reflector Config -

Reflector Config

+

Reflector Config

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
diff --git a/gencode/docs/reflect_state.html b/gencode/docs/reflect_state.html index 4ac719a337..a2e83558fc 100644 --- a/gencode/docs/reflect_state.html +++ b/gencode/docs/reflect_state.html @@ -15,7 +15,7 @@ Reflector State -

Reflector State

+

Reflector State

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
diff --git a/gencode/docs/state.html b/gencode/docs/state.html index afebcbb046..af960a8241 100644 --- a/gencode/docs/state.html +++ b/gencode/docs/state.html @@ -15,7 +15,7 @@ State -

State

+

State

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -171,7 +171,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -257,7 +257,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -430,9 +430,9 @@


Examples:
-
"A1B2C3D4"
+
"A1B2C3D4"
 
-
"00001"
+
"00001"
 
@@ -523,7 +523,7 @@


Example:
-
"Google"
+
"Google"
 
@@ -575,11 +575,11 @@


Examples:
-
"Pixel 5"
+
"Pixel 5"
 
-
"Pixel 6"
+
"Pixel 6"
 
-
"Pixel 6 Pro"
+
"Pixel 6 Pro"
 
@@ -631,9 +631,9 @@


Examples:
-
"GF5KQ"
+
"GF5KQ"
 
-
"4215612"
+
"4215612"
 
@@ -685,11 +685,11 @@


Examples:
-
"A"
+
"A"
 
-
"B"
+
"B"
 
-
"1"
+
"1"
 
@@ -738,11 +738,11 @@


Examples:
-
"firmware"
+
"firmware"
 
-
"os"
+
"os"
 
-
"driver"
+
"driver"
 
@@ -976,7 +976,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -2480,7 +2480,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -2532,7 +2532,7 @@


Example:
-
600
+
600
 
@@ -2769,7 +2769,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -4679,7 +4679,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -4745,7 +4745,7 @@


Example:
-
600
+
600
 
@@ -5033,7 +5033,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -6740,7 +6740,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -6799,7 +6799,7 @@


Example:
-
600
+
600
 
@@ -7124,7 +7124,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -9034,7 +9034,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -9100,7 +9100,7 @@


Example:
-
600
+
600
 
@@ -9411,7 +9411,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -11321,7 +11321,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -11387,7 +11387,7 @@


Example:
-
600
+
600
 
@@ -11480,7 +11480,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -11653,7 +11653,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -13157,7 +13157,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -13209,7 +13209,7 @@


Example:
-
600
+
600
 
@@ -13533,7 +13533,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -15443,7 +15443,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -15509,7 +15509,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/state_mapping.html b/gencode/docs/state_mapping.html index 9dbd562e8f..f857c4bdc3 100644 --- a/gencode/docs/state_mapping.html +++ b/gencode/docs/state_mapping.html @@ -15,7 +15,7 @@ Mapping State -

Mapping State

+

Mapping State

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -560,7 +560,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -2267,7 +2267,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -2326,7 +2326,7 @@


Example:
-
600
+
600
 
diff --git a/gencode/docs/state_pointset.html b/gencode/docs/state_pointset.html index 95ead3c5c3..2b3202e5a0 100644 --- a/gencode/docs/state_pointset.html +++ b/gencode/docs/state_pointset.html @@ -14,8 +14,8 @@ Pointset State - -

Pointset State

+ +

Pointset State

diff --git a/gencode/docs/state_validation.html b/gencode/docs/state_validation.html index 5756db674f..a56b478c9a 100644 --- a/gencode/docs/state_validation.html +++ b/gencode/docs/state_validation.html @@ -15,7 +15,7 @@ Validation State -

Validation State

+

Validation State

@@ -60,7 +60,7 @@


Example:
-
"2019-01-17T14:02:29.364Z"
+
"2019-01-17T14:02:29.364Z"
 
@@ -204,7 +204,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -1505,7 +1505,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -1550,7 +1550,7 @@


Example:
-
600
+
600
 
@@ -2160,7 +2160,7 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 
@@ -3867,7 +3867,7 @@


Example:
-
"2018-08-26T21:39:28.364Z"
+
"2018-08-26T21:39:28.364Z"
 
@@ -3926,7 +3926,7 @@


Example:
-
600
+
600
 
diff --git a/schema/envelope.json b/schema/envelope.json index 1d153849b8..f025cc7e2c 100644 --- a/schema/envelope.json +++ b/schema/envelope.json @@ -1,6 +1,7 @@ { "title": "Envelope", "description": "The UDMI `envelope` is not a message itself, per se, but the attributes and other information that is delivered along with a message. [Message Envelope Documentation](../docs/messages/envelope.md)", + "$section": "Messages", "additionalProperties": true, "properties": { "deviceId": {