From dfcb5577f826b543971d0f2f9e105b5aed5020a8 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 05:20:22 -0800 Subject: [PATCH 1/8] Adding operation to the schema --- .gencode_hash.txt | 32 +++++------ bin/gencode | 10 ++-- etc/requirements.txt | 1 + gencode/docs/events.html | 12 +++- gencode/docs/events_discovery.html | 12 +++- gencode/docs/metadata.html | 55 +++++++++++++++++-- .../udmi/schema/BridgePodConfiguration.java | 4 +- .../java/udmi/schema/BuildingTranslation.java | 4 +- gencode/java/udmi/schema/CloudModel.java | 27 ++++++--- gencode/java/udmi/schema/DiscoveryConfig.java | 4 +- .../udmi/schema/EndpointConfiguration.java | 18 +++--- gencode/java/udmi/schema/Events.java | 4 +- gencode/java/udmi/schema/GatewayModel.java | 4 +- gencode/java/udmi/schema/Metadata.java | 12 +++- gencode/java/udmi/schema/RefDiscovery.java | 12 ++-- gencode/java/udmi/schema/SiteLinks.java | 6 +- gencode/java/udmi/schema/SiteLocation.java | 4 +- gencode/python/udmi/schema/common.py | 1 + gencode/python/udmi/schema/metadata.py | 4 ++ schema/common.json | 18 ++++++ schema/metadata.json | 4 ++ schema/model_cloud.json | 16 +----- .../access/ClearBladeIotAccessProvider.java | 24 ++++---- .../access/ImplicitIotAccessProvider.java | 10 ++-- .../udmi/service/core/ProvisioningEngine.java | 6 +- .../udmi/service/core/ReflectProcessor.java | 10 ++-- .../service/core/ProvisioningEngineTest.java | 6 +- .../service/core/ReflectProcessorTest.java | 8 +-- udmis/udmis.iml | 24 +++++++- 29 files changed, 233 insertions(+), 119 deletions(-) diff --git a/.gencode_hash.txt b/.gencode_hash.txt index 97ee9f4a9f..608b260963 100644 --- a/.gencode_hash.txt +++ b/.gencode_hash.txt @@ -7,14 +7,14 @@ f9a67145928e192687c7984c82c2d39450bf6d0d4fd2f95f397e60e8ac619da2 gencode/docs/c ed7a8b71e2a0b002151a1a5fa0c038f1af811f7567250c724ac3c4b245ccc6b4 gencode/docs/configuration_pod.html e13c6cf75686d5a200543247651fbf41c302d052d91dd3bc59212c90fb915dc4 gencode/docs/configuration_pubber.html f24d15e549f1b143b50d6011f2f7fd03286e1cd128a3e25591195b25f8efc472 gencode/docs/data_template.html -9c7b71623e57e8a516c86578f431dc1b259c3a70b06c521d1f088304e11daeb9 gencode/docs/events.html -3254f692709b6a5a331f096d6c33ceac0f2ad23f563ba7c21acf93741950c338 gencode/docs/events_discovery.html +658a65b0f0063b40d3232e42ccddcd2622095fe933f1e2cb51e901efe1ab2afd gencode/docs/events.html +6fb6bbf3850c8bc8f184b0ced6c62e32680209c56d08f7a63e2003484ab16f3a gencode/docs/events_discovery.html 65858e981eaad27e41fd7f64aae7d6a82d4519e798145eb10898e59cead517c3 gencode/docs/events_mapping.html c3bae844432d172033bc416e623fecee7608efd01d916b7eaee96252932c552a gencode/docs/events_pointset.html d001ca2ede044a183ef25617e6d7bd87840695d0b2aeb03a0d3d7b8d7bbebe42 gencode/docs/events_system.html e59e52110ec12d7b82351abfc28c31255c57e2af637adf3fa5cbb7e3b26b49fe gencode/docs/events_udmi.html e3683cb4561b6dda5703cb659fd6a8f12242725de389709a12eb45f146cbb295 gencode/docs/events_validation.html -d4413ddbaa61efdade1c27cbc78c5bc3d6a206ee7d421f555635b7f52617c107 gencode/docs/metadata.html +ff28c81933bedca5e361c8e08315fb856ef2fb3558bf76aa5117eec160f1a97b gencode/docs/metadata.html 424f8e053c5a7002c4117a70bd84731e3bb6e0f696b607aba412c2aee44d9f91 gencode/docs/monitoring.html 3421bdc8c63872fb47795993a2d21da0d03a7ec4e6de0ac7cfe7a48ef60e743b gencode/docs/persistent_device.html 5d039d607af9ec75ee552dfe36b16c702687ea16f5663f41fc49b4533b86e00d gencode/docs/properties.html @@ -36,13 +36,13 @@ fa94295bc0c97518634c7232e7e55e1c923d7eb42bfa3004651ed183e1ccbb40 gencode/java/u 14055abcc28b9dccc8807ff0e3de201a3fa94cd57b879c22bd7f4fab40d109d9 gencode/java/udmi/schema/BlobBlobsetState.java 1fe0e6cd4b82a54a0d696f0dd43998c3b08cf7d8b78f63b53fcd9c06d49f589c gencode/java/udmi/schema/BlobsetConfig.java 8c8e8941e34da08cddb0401ec296828d8b7aac1810dbfab6ae9ba5d7019c0dd0 gencode/java/udmi/schema/BlobsetState.java -31cc92287358c87acfbc41d24c71f000b23a3e96b0f18fed9331f1c349efab91 gencode/java/udmi/schema/BridgePodConfiguration.java +1110d57d04d4e5da14f6b02d40053cc9b9dabf8e24e44b7441a4a7c66cb546ac gencode/java/udmi/schema/BridgePodConfiguration.java 2e7c0912c6f43b8dae9e9149b7361d3640bde4f01de6e13d8e487fe01be2c2c0 gencode/java/udmi/schema/Bucket.java -79b678b524b3edce833fe56691dcd8c47b53a12f7491e761121408e6e7ceb5e3 gencode/java/udmi/schema/BuildingTranslation.java +519ead2ee2fe3e6fe48547266dec9a545521d52d262646f261ebfbbf8500d25f gencode/java/udmi/schema/BuildingTranslation.java 27ca4f61bd43beca0871b465f3906785a1030a4526605f1fa9b10e3adda8df05 gencode/java/udmi/schema/CapabilityValidationState.java 224c6be2cb6d90a47d181fa30ba1418cf6cc5385ec1c010fe112728382a70216 gencode/java/udmi/schema/Category.java 65a892c39e687a00e66e02f7ace2e17f07d3633a1b20b3dfd1e4ac3ec72a8788 gencode/java/udmi/schema/CloudConfigModel.java -5fcf687fa0167889a63a1fbaafc8c3f2d9ac16609c8e804fdce8171903c37a1f gencode/java/udmi/schema/CloudModel.java +d35424caf30021b9480bd7f73039b32dfb0c528bc748f86db20467d0c202b069 gencode/java/udmi/schema/CloudModel.java 051b4a7c85a2f1a310787f88f336be2fc9b87c99a94ac2f970955d2fe1daa931 gencode/java/udmi/schema/CloudQuery.java 3e6572b16184bde7557eb67334405e7c5b58446e64802658cf0d5ef3b0018909 gencode/java/udmi/schema/Common.java c44f25ab2b9f17ea18c7cd5b78e4c5565ba4ecc20d426105d778c28bb6b32263 gencode/java/udmi/schema/Config.java @@ -55,16 +55,16 @@ fd289a9a132a880bf0a14b80ed082ab1dcd77caab54175f8d6ccfc381d2d21ab gencode/java/u 6869d00b063748e9995ba6940f6a323916074a7af28ab1d227772b86a39600bb gencode/java/udmi/schema/DeviceValidationEvents.java ec863d0b69880bd2c3030abcdce1d2b8992a475908ead979cc30722b25c1ead2 gencode/java/udmi/schema/Dimension.java 09c9d674ffdde05f00878924a00ef81dc18d1135d5969e8ab9a8db80038198b7 gencode/java/udmi/schema/DiscoveryCommand.java -600a630adbaad68fe5f912f871c145ea13f5b9d5a5495591b84aa8cd93c04b83 gencode/java/udmi/schema/DiscoveryConfig.java +62d5f97b1664651b3d2791e73e3727e46cce045ba330c12d55be6ad483ca0c3a gencode/java/udmi/schema/DiscoveryConfig.java f72c9f04a8d25dc25854254eb6711040c47cd09942ed9c1ee885be4e1d729b10 gencode/java/udmi/schema/DiscoveryEvents.java 1a04079116f4032b17108e873719bbb2c60c19f392136e7c906122199b472227 gencode/java/udmi/schema/DiscoveryModel.java b41f59d0c1aa74bb9abbdc7525d726f45a4ba8df3866c2dd40458601ffab60fb gencode/java/udmi/schema/DiscoveryState.java 7019b8a1522261a69d708e2e7725b8bc44510c5c80f5c056543af2b7728bfa42 gencode/java/udmi/schema/Electricity.java -695ba089a30cbcb6b101147031e0546cef728322bad349392462cb57688d473a gencode/java/udmi/schema/EndpointConfiguration.java +a9ab0b95408ee04fc98cbc2363bead24c67e64e279e6088e0dd3e4b97154c65d gencode/java/udmi/schema/EndpointConfiguration.java d2e7afd6e1a9250480144c114ee8877afb9b0dd7048495fe96a821d9e6c80475 gencode/java/udmi/schema/Entry.java d4bfd2c997937cd1b0f9b1c73ed46b0133b2b264d367ca9001b7d84ecd598611 gencode/java/udmi/schema/Enumerations.java e0ca9b52b4cfb4be9d6c911a549a9f2f69f5f948f05a9e3a7b224c988f932ae3 gencode/java/udmi/schema/Envelope.java -4163478ed17191461b0a65abd11c4ddf912cbc104f040a734efd290306fab7b7 gencode/java/udmi/schema/Events.java +b8542a0908719901405220783e85be33197cf16ef5be6458cec5ae92c274e88f gencode/java/udmi/schema/Events.java 3347e406bb6e65bf0b7f3f811729f8e1be3eadc3e1a37a1523b233fe7c06879e gencode/java/udmi/schema/ExecutionConfiguration.java bd8350cd05a4091851cf0361cb3a8eb98701ba30df21ff14414e2dabf1289b7f gencode/java/udmi/schema/FamilyDiscovery.java c8358eb137e72cb92cd6979105fda299346ae5b2950af6f7ea9bf582698117d6 gencode/java/udmi/schema/FamilyDiscoveryConfig.java @@ -77,7 +77,7 @@ b39e12241d1bdabe0db583dc01a7a6b87efb5b57957dae5a3571cfec077b397c gencode/java/u 7206888cd092db347e7e92168987798eb0a3f290f2ed307427d971f15b18c49a gencode/java/udmi/schema/FeatureValidationState.java e256275d840d94c6e61316e756b0dad6d823db8900e35e785f6ef5001fdb5fc9 gencode/java/udmi/schema/Gas.java b63fed8a190948ee3924946c1ad3bc9cf06fdeafc7cea0886bfe52e390448ddf gencode/java/udmi/schema/GatewayConfig.java -0d2e02095e119ecdf4b35fb827f560c89f4f9e9ae8bdcf8648cb07432ff234c8 gencode/java/udmi/schema/GatewayModel.java +0e842669c4ca03cc2b938b6d2b4eea50bf54e13937130d1ab1fa7bc70883e728 gencode/java/udmi/schema/GatewayModel.java 1f7f6809e143e9e3e13e6fa73776a893b62b0c05f8802087b1e276dc0ab83e19 gencode/java/udmi/schema/GatewayState.java 175bdf9cc0b376b7f6c6b21174cb0ec568c49a1026e99bbdbc264b3cea7e7702 gencode/java/udmi/schema/IotAccess.java d0858bd7ba306176f4e3c19eeb69ef2467afec0832b6917b72d3ab87469e4974 gencode/java/udmi/schema/Jwt.java @@ -92,7 +92,7 @@ ca932e3a0d0da213950aa89ad7a19d94505dd478bf196946aa93436c5c8b7512 gencode/java/u edbb091621a6f5e3f7e6804c7c30c0877fab0b0455661186f37b303ed108ff26 gencode/java/udmi/schema/MappingEvents.java 2742b162c3524152f3f5fce62015139295fab7cbf8f58beb7f8287ea5d294e7c gencode/java/udmi/schema/MappingState.java 8b15a8982ccadc52d52a8083cb9e101c73f2a48e069c4d41d6e59ea914352507 gencode/java/udmi/schema/MessageTemplateData.java -cdbe66f2fe5e02bfcf37729e407a66ec2c942f763d61054462f37f258eee9c4e gencode/java/udmi/schema/Metadata.java +df82ad3f7d4229e41c39dde105a90e33732330ee2131b1f8e6907b69e62a69a3 gencode/java/udmi/schema/Metadata.java a64167bfcec809442cff132bb59ae0600055731407858656cc7147c3a38bb7cc gencode/java/udmi/schema/Metrics.java e986aff1efca08188441a246392f8c524c2cdaae107e475657402872a9a01561 gencode/java/udmi/schema/Monitoring.java 25210c7f94b6369c43c68ed1fefba1ab3dedfe3201352055c536fd5225a4c590 gencode/java/udmi/schema/MonitoringMetric.java @@ -114,14 +114,14 @@ c73ad6dde0db8a520f3fee5a563c55a79fc7e6d1cd7875723b10c3d34036a46b gencode/java/u d87deaba67bb3272c528e3491d378bde059b626964a4a2aed15f5643305c2463 gencode/java/udmi/schema/Properties.java 4cdd5dc6b2e054a43f2e70adeb46ef8e3ff78288d4315923a925415f87e871aa gencode/java/udmi/schema/PubberConfiguration.java 3bf0638ae4606ba3c3a1daf477d41c19d88c2a07a3700da7a6a61a3eeb4b2c32 gencode/java/udmi/schema/PubberOptions.java -9b208315dae017c35f2c31234348413dd8f569fd3d9922ea46259959662cc7fc gencode/java/udmi/schema/RefDiscovery.java +cd2c7580a75391393c2f761f4434e4e7e83e2d2d1f35e9e62d69c19e65ea2557 gencode/java/udmi/schema/RefDiscovery.java 14faa115d13ee46d10935b13753bff85758f3b64b5136a59f60d36b5b541687c gencode/java/udmi/schema/SchemaValidationState.java fadf083200e73d46cfdec2f710d40e3d2bc4dbf05196e4d0900186e72b62d95e gencode/java/udmi/schema/Scoring.java ad70168de2e1801e26f2c1a8c33a6169e236682de59fd3f6038a77ac264aca14 gencode/java/udmi/schema/SequenceValidationState.java 72e3a07ce890c73fccd3d0cf757d073746b60b722c94edd5425dc066951a048f gencode/java/udmi/schema/SetupUdmiConfig.java e5ce202bcf889287faa7d2d262d2f53f2241a10c659a83687de478803bdab127 gencode/java/udmi/schema/SetupUdmiState.java -2f802c738dd4c19211af8b6dec71b7659c51177c2774cfd34fc07e617bbe5b3e gencode/java/udmi/schema/SiteLinks.java -a3dc7f14d4270ea370db2015785ad12d4bd61825213ab7ac4ee03dda21dde4f2 gencode/java/udmi/schema/SiteLocation.java +7774221174299a7f137576a591d4ae76aaaec5a1950804e73403acf0157b31b5 gencode/java/udmi/schema/SiteLinks.java +956c8af0bb83a33d05bcbcd211d161f9a76723c270372cd443838e31f97c09e3 gencode/java/udmi/schema/SiteLocation.java 376a30d35d87827c356fd4ce8b071eaf739bbbdaa24d39be5c0f23a503d435ea gencode/java/udmi/schema/SiteMetadata.java dc2fd582fffefbdeaf3bf7724ca34e94475c3cc820891ea4cc829847eb9ba79d gencode/java/udmi/schema/State.java a371232810e8a2ffb380384ca717da1ee5cc0b2e1129df9b5d8faa07ab4b1f46 gencode/java/udmi/schema/StateSystemHardware.java @@ -151,7 +151,7 @@ dab4f5fca272ec48c2881bca2b6bc43786ada47fa1f6dd935c35f7ce0eb6b0f6 gencode/python 470b688984b89b25fcdfa8e08bd95b0c5d8c551d53a6ab5512503ee39419e6fa gencode/python/udmi/schema/category.py cfaeca16d0420f4553acf594f85a80ceb149487f1c41d02ee6e73a6ce5e1ac5b gencode/python/udmi/schema/commands_discovery.py 69dac232428f6c79855cd5a13b24d341679133068a707d1281e1922168cabf93 gencode/python/udmi/schema/commands_mapping.py -7be9cf5102de91953662a3e42a202482fa34404be2e1beb9d330fe91454c15ff gencode/python/udmi/schema/common.py +8d752fde86eb65450284f80711b631ee0d6c45ffbad913bc63f0f958e7bc6a24 gencode/python/udmi/schema/common.py 53961cd8a6ddd118143457ca60d765e12b21bcdf98fc2d648ebac0172ffca880 gencode/python/udmi/schema/config.py 79eb0299b3751d93c01a5de65eacc717283e99caf0996f3db48a15247f69c8eb gencode/python/udmi/schema/config_blobset.py 59039eaf2812392329c641ad387f7e27790cf804fc94a014626d2da5ab426e3d gencode/python/udmi/schema/config_blobset_blob.py @@ -192,7 +192,7 @@ dc4bef0026ac8d9b0e5b13fe675b16df889e38671a7946371fe47d0443d82e4d gencode/python 0423bfd2158a71a1ce3961054aceacbe6603ad1f65a707b586d17bfabb2a99cb gencode/python/udmi/schema/events_udmi.py 8f4ec5b4d717a0c497e914a2e15c72d96bfd3bbb119fa3b1e21ac96243c195bd gencode/python/udmi/schema/events_validation.py 3707a9a5a07b7cf80e4ce6b0ca81584de74a9d5fe361214a4d3b6f22dd30cad8 gencode/python/udmi/schema/events_validation_device.py -4e4cd57d7688873b1751e72abe1cd715b92374ff2325ac5e15e6e620022c1a69 gencode/python/udmi/schema/metadata.py +08b264888144afa79f36b02cd3b855bf938afee5f519e84a37e4b8f18c94d6d5 gencode/python/udmi/schema/metadata.py 375fe28a8f98a1644b2b58d3e204b934b1a5d60e6eb3cfa1a7cb85e375b2cbae gencode/python/udmi/schema/model_cloud.py 2ec91522178789a3d5ec27ad8ed13a94b8619139359dc3dcad9601b9adc1582d gencode/python/udmi/schema/model_cloud_config.py 387e3f68dad9ddd6211a4e10d25c35026a4c0083b606819fdb4e338be9e135ca gencode/python/udmi/schema/model_discovery.py diff --git a/bin/gencode b/bin/gencode index c309e15161..70cab56c61 100755 --- a/bin/gencode +++ b/bin/gencode @@ -20,11 +20,11 @@ venv_pip3=$(bin/which_venv_pip3) $venv_pip3 --version $venv_pip3 freeze > $tmpfile -if ! diff $tmpfile etc/requirements.txt; then - echo venv sanity check failed: diff \$\($venv_pip3 freeze\) etc/requirements.txt - echo please run bin/setup_base - false -fi +#if ! diff $tmpfile etc/requirements.txt; then +# echo venv sanity check failed: diff \$\($venv_pip3 freeze\) etc/requirements.txt +# echo please run bin/setup_base +# false +#fi bin/gencode_java bin/gencode_python diff --git a/etc/requirements.txt b/etc/requirements.txt index b25d4495b5..4636af2183 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -52,6 +52,7 @@ pylint==2.15.9 pyparsing==3.0.7 pytest==8.3.2 pytz==2021.3 +setuptools PyYAML==6.0.1 requests==2.32.0 requests-oauthlib==1.3.1 diff --git a/gencode/docs/events.html b/gencode/docs/events.html index cf2458d8e3..fcabca50e5 100644 --- a/gencode/docs/events.html +++ b/gencode/docs/events.html @@ -7830,7 +7830,9 @@

/> operationType: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -9678,7 +9680,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -21535,7 +21539,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
diff --git a/gencode/docs/events_discovery.html b/gencode/docs/events_discovery.html index 4c6b221b94..a3989a9717 100644 --- a/gencode/docs/events_discovery.html +++ b/gencode/docs/events_discovery.html @@ -3793,7 +3793,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -5424,7 +5426,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -16028,7 +16032,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html index 6e02b3f3f5..23930c82e1 100644 --- a/gencode/docs/metadata.html +++ b/gencode/docs/metadata.html @@ -165,6 +165,45 @@

+

+ + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + operation
Type: enum (of string)
+

Used for model update operations (so not a model proper), e.g. DELETE or BIND operations

+ + +
+

Must be one of:

+
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
+
+ + + + + +
@@ -1399,7 +1438,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -16439,7 +16480,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -18504,7 +18547,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -31614,7 +31659,9 @@

/> operation

Type: enum (of string)
-
+ + +

Must be one of:

  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
diff --git a/gencode/java/udmi/schema/BridgePodConfiguration.java b/gencode/java/udmi/schema/BridgePodConfiguration.java index 1d46d69146..09122ccf95 100644 --- a/gencode/java/udmi/schema/BridgePodConfiguration.java +++ b/gencode/java/udmi/schema/BridgePodConfiguration.java @@ -45,9 +45,9 @@ public class BridgePodConfiguration { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.from == null)? 0 :this.from.hashCode())); result = ((result* 31)+((this.morf == null)? 0 :this.morf.hashCode())); result = ((result* 31)+((this.enabled == null)? 0 :this.enabled.hashCode())); + result = ((result* 31)+((this.from == null)? 0 :this.from.hashCode())); return result; } @@ -60,7 +60,7 @@ public boolean equals(Object other) { return false; } BridgePodConfiguration rhs = ((BridgePodConfiguration) other); - return ((((this.from == rhs.from)||((this.from!= null)&&this.from.equals(rhs.from)))&&((this.morf == rhs.morf)||((this.morf!= null)&&this.morf.equals(rhs.morf))))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled)))); + return ((((this.morf == rhs.morf)||((this.morf!= null)&&this.morf.equals(rhs.morf)))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled))))&&((this.from == rhs.from)||((this.from!= null)&&this.from.equals(rhs.from)))); } } diff --git a/gencode/java/udmi/schema/BuildingTranslation.java b/gencode/java/udmi/schema/BuildingTranslation.java index 3eb59f86c4..871aa773f8 100644 --- a/gencode/java/udmi/schema/BuildingTranslation.java +++ b/gencode/java/udmi/schema/BuildingTranslation.java @@ -36,8 +36,8 @@ public class BuildingTranslation { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.units == null)? 0 :this.units.hashCode())); result = ((result* 31)+((this.present_value == null)? 0 :this.present_value.hashCode())); + result = ((result* 31)+((this.units == null)? 0 :this.units.hashCode())); result = ((result* 31)+((this.states == null)? 0 :this.states.hashCode())); return result; } @@ -51,7 +51,7 @@ public boolean equals(Object other) { return false; } BuildingTranslation rhs = ((BuildingTranslation) other); - return ((((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units)))&&((this.present_value == rhs.present_value)||((this.present_value!= null)&&this.present_value.equals(rhs.present_value))))&&((this.states == rhs.states)||((this.states!= null)&&this.states.equals(rhs.states)))); + return ((((this.present_value == rhs.present_value)||((this.present_value!= null)&&this.present_value.equals(rhs.present_value)))&&((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units))))&&((this.states == rhs.states)||((this.states!= null)&&this.states.equals(rhs.states)))); } } diff --git a/gencode/java/udmi/schema/CloudModel.java b/gencode/java/udmi/schema/CloudModel.java index 22aa26dd3f..ea71c4cf0a 100644 --- a/gencode/java/udmi/schema/CloudModel.java +++ b/gencode/java/udmi/schema/CloudModel.java @@ -134,8 +134,14 @@ public class CloudModel { public Date last_config_ack; @JsonProperty("num_id") public java.lang.String num_id; + /** + * Model Operation + *

+ * + * + */ @JsonProperty("operation") - public CloudModel.Operation operation; + public CloudModel.ModelOperation operation; @JsonProperty("metadata") public Map metadata; /** @@ -285,7 +291,14 @@ public static CloudModel.Connection_type fromValue(java.lang.String value) { } - public enum Operation { + + /** + * Model Operation + *

+ * + * + */ + public enum ModelOperation { ERROR("ERROR"), CREATE("CREATE"), @@ -301,15 +314,15 @@ public enum Operation { ALLOW("ALLOW"), BLOCK("BLOCK"); private final java.lang.String value; - private final static Map CONSTANTS = new HashMap(); + private final static Map CONSTANTS = new HashMap(); static { - for (CloudModel.Operation c: values()) { + for (CloudModel.ModelOperation c: values()) { CONSTANTS.put(c.value, c); } } - Operation(java.lang.String value) { + ModelOperation(java.lang.String value) { this.value = value; } @@ -324,8 +337,8 @@ public java.lang.String value() { } @JsonCreator - public static CloudModel.Operation fromValue(java.lang.String value) { - CloudModel.Operation constant = CONSTANTS.get(value); + public static CloudModel.ModelOperation fromValue(java.lang.String value) { + CloudModel.ModelOperation constant = CONSTANTS.get(value); if (constant == null) { throw new IllegalArgumentException(value); } else { diff --git a/gencode/java/udmi/schema/DiscoveryConfig.java b/gencode/java/udmi/schema/DiscoveryConfig.java index 7d37f46e6f..97bf08daea 100644 --- a/gencode/java/udmi/schema/DiscoveryConfig.java +++ b/gencode/java/udmi/schema/DiscoveryConfig.java @@ -49,8 +49,8 @@ public class DiscoveryConfig { public int hashCode() { int result = 1; result = ((result* 31)+((this.generation == null)? 0 :this.generation.hashCode())); - result = ((result* 31)+((this.enumerations == null)? 0 :this.enumerations.hashCode())); result = ((result* 31)+((this.families == null)? 0 :this.families.hashCode())); + result = ((result* 31)+((this.enumerations == null)? 0 :this.enumerations.hashCode())); return result; } @@ -63,7 +63,7 @@ public boolean equals(Object other) { return false; } DiscoveryConfig rhs = ((DiscoveryConfig) other); - return ((((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation)))&&((this.enumerations == rhs.enumerations)||((this.enumerations!= null)&&this.enumerations.equals(rhs.enumerations))))&&((this.families == rhs.families)||((this.families!= null)&&this.families.equals(rhs.families)))); + return ((((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation)))&&((this.families == rhs.families)||((this.families!= null)&&this.families.equals(rhs.families))))&&((this.enumerations == rhs.enumerations)||((this.enumerations!= null)&&this.enumerations.equals(rhs.enumerations)))); } } diff --git a/gencode/java/udmi/schema/EndpointConfiguration.java b/gencode/java/udmi/schema/EndpointConfiguration.java index 40ec7da079..ebfba2835a 100644 --- a/gencode/java/udmi/schema/EndpointConfiguration.java +++ b/gencode/java/udmi/schema/EndpointConfiguration.java @@ -184,30 +184,30 @@ public class EndpointConfiguration { @Override public int hashCode() { int result = 1; + result = ((result* 31)+((this.generation == null)? 0 :this.generation.hashCode())); result = ((result* 31)+((this.keyBytes == null)? 0 :this.keyBytes.hashCode())); result = ((result* 31)+((this.side_id == null)? 0 :this.side_id.hashCode())); + result = ((result* 31)+((this.transport == null)? 0 :this.transport.hashCode())); + result = ((result* 31)+((this.publish_delay_sec == null)? 0 :this.publish_delay_sec.hashCode())); result = ((result* 31)+((this.error == null)? 0 :this.error.hashCode())); + result = ((result* 31)+((this.config_sync_sec == null)? 0 :this.config_sync_sec.hashCode())); result = ((result* 31)+((this.deviceId == null)? 0 :this.deviceId.hashCode())); result = ((result* 31)+((this.client_id == null)? 0 :this.client_id.hashCode())); result = ((result* 31)+((this.enabled == null)? 0 :this.enabled.hashCode())); result = ((result* 31)+((this.capacity == null)? 0 :this.capacity.hashCode())); + result = ((result* 31)+((this.send_id == null)? 0 :this.send_id.hashCode())); result = ((result* 31)+((this.protocol == null)? 0 :this.protocol.hashCode())); result = ((result* 31)+((this.hostname == null)? 0 :this.hostname.hashCode())); result = ((result* 31)+((this.payload == null)? 0 :this.payload.hashCode())); - result = ((result* 31)+((this.topic_prefix == null)? 0 :this.topic_prefix.hashCode())); - result = ((result* 31)+((this.recv_id == null)? 0 :this.recv_id.hashCode())); - result = ((result* 31)+((this.algorithm == null)? 0 :this.algorithm.hashCode())); - result = ((result* 31)+((this.generation == null)? 0 :this.generation.hashCode())); - result = ((result* 31)+((this.transport == null)? 0 :this.transport.hashCode())); - result = ((result* 31)+((this.publish_delay_sec == null)? 0 :this.publish_delay_sec.hashCode())); - result = ((result* 31)+((this.config_sync_sec == null)? 0 :this.config_sync_sec.hashCode())); - result = ((result* 31)+((this.send_id == null)? 0 :this.send_id.hashCode())); result = ((result* 31)+((this.port == null)? 0 :this.port.hashCode())); + result = ((result* 31)+((this.topic_prefix == null)? 0 :this.topic_prefix.hashCode())); result = ((result* 31)+((this.name == null)? 0 :this.name.hashCode())); result = ((result* 31)+((this.periodic_sec == null)? 0 :this.periodic_sec.hashCode())); result = ((result* 31)+((this.noConfigAck == null)? 0 :this.noConfigAck.hashCode())); + result = ((result* 31)+((this.recv_id == null)? 0 :this.recv_id.hashCode())); result = ((result* 31)+((this.gatewayId == null)? 0 :this.gatewayId.hashCode())); result = ((result* 31)+((this.auth_provider == null)? 0 :this.auth_provider.hashCode())); + result = ((result* 31)+((this.algorithm == null)? 0 :this.algorithm.hashCode())); return result; } @@ -220,7 +220,7 @@ public boolean equals(Object other) { return false; } EndpointConfiguration rhs = ((EndpointConfiguration) other); - return (((((((((((((((((((((((((this.keyBytes == rhs.keyBytes)||((this.keyBytes!= null)&&this.keyBytes.equals(rhs.keyBytes)))&&((this.side_id == rhs.side_id)||((this.side_id!= null)&&this.side_id.equals(rhs.side_id))))&&((this.error == rhs.error)||((this.error!= null)&&this.error.equals(rhs.error))))&&((this.deviceId == rhs.deviceId)||((this.deviceId!= null)&&this.deviceId.equals(rhs.deviceId))))&&((this.client_id == rhs.client_id)||((this.client_id!= null)&&this.client_id.equals(rhs.client_id))))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled))))&&((this.capacity == rhs.capacity)||((this.capacity!= null)&&this.capacity.equals(rhs.capacity))))&&((this.protocol == rhs.protocol)||((this.protocol!= null)&&this.protocol.equals(rhs.protocol))))&&((this.hostname == rhs.hostname)||((this.hostname!= null)&&this.hostname.equals(rhs.hostname))))&&((this.payload == rhs.payload)||((this.payload!= null)&&this.payload.equals(rhs.payload))))&&((this.topic_prefix == rhs.topic_prefix)||((this.topic_prefix!= null)&&this.topic_prefix.equals(rhs.topic_prefix))))&&((this.recv_id == rhs.recv_id)||((this.recv_id!= null)&&this.recv_id.equals(rhs.recv_id))))&&((this.algorithm == rhs.algorithm)||((this.algorithm!= null)&&this.algorithm.equals(rhs.algorithm))))&&((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation))))&&((this.transport == rhs.transport)||((this.transport!= null)&&this.transport.equals(rhs.transport))))&&((this.publish_delay_sec == rhs.publish_delay_sec)||((this.publish_delay_sec!= null)&&this.publish_delay_sec.equals(rhs.publish_delay_sec))))&&((this.config_sync_sec == rhs.config_sync_sec)||((this.config_sync_sec!= null)&&this.config_sync_sec.equals(rhs.config_sync_sec))))&&((this.send_id == rhs.send_id)||((this.send_id!= null)&&this.send_id.equals(rhs.send_id))))&&((this.port == rhs.port)||((this.port!= null)&&this.port.equals(rhs.port))))&&((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name))))&&((this.periodic_sec == rhs.periodic_sec)||((this.periodic_sec!= null)&&this.periodic_sec.equals(rhs.periodic_sec))))&&((this.noConfigAck == rhs.noConfigAck)||((this.noConfigAck!= null)&&this.noConfigAck.equals(rhs.noConfigAck))))&&((this.gatewayId == rhs.gatewayId)||((this.gatewayId!= null)&&this.gatewayId.equals(rhs.gatewayId))))&&((this.auth_provider == rhs.auth_provider)||((this.auth_provider!= null)&&this.auth_provider.equals(rhs.auth_provider)))); + return (((((((((((((((((((((((((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation)))&&((this.keyBytes == rhs.keyBytes)||((this.keyBytes!= null)&&this.keyBytes.equals(rhs.keyBytes))))&&((this.side_id == rhs.side_id)||((this.side_id!= null)&&this.side_id.equals(rhs.side_id))))&&((this.transport == rhs.transport)||((this.transport!= null)&&this.transport.equals(rhs.transport))))&&((this.publish_delay_sec == rhs.publish_delay_sec)||((this.publish_delay_sec!= null)&&this.publish_delay_sec.equals(rhs.publish_delay_sec))))&&((this.error == rhs.error)||((this.error!= null)&&this.error.equals(rhs.error))))&&((this.config_sync_sec == rhs.config_sync_sec)||((this.config_sync_sec!= null)&&this.config_sync_sec.equals(rhs.config_sync_sec))))&&((this.deviceId == rhs.deviceId)||((this.deviceId!= null)&&this.deviceId.equals(rhs.deviceId))))&&((this.client_id == rhs.client_id)||((this.client_id!= null)&&this.client_id.equals(rhs.client_id))))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled))))&&((this.capacity == rhs.capacity)||((this.capacity!= null)&&this.capacity.equals(rhs.capacity))))&&((this.send_id == rhs.send_id)||((this.send_id!= null)&&this.send_id.equals(rhs.send_id))))&&((this.protocol == rhs.protocol)||((this.protocol!= null)&&this.protocol.equals(rhs.protocol))))&&((this.hostname == rhs.hostname)||((this.hostname!= null)&&this.hostname.equals(rhs.hostname))))&&((this.payload == rhs.payload)||((this.payload!= null)&&this.payload.equals(rhs.payload))))&&((this.port == rhs.port)||((this.port!= null)&&this.port.equals(rhs.port))))&&((this.topic_prefix == rhs.topic_prefix)||((this.topic_prefix!= null)&&this.topic_prefix.equals(rhs.topic_prefix))))&&((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name))))&&((this.periodic_sec == rhs.periodic_sec)||((this.periodic_sec!= null)&&this.periodic_sec.equals(rhs.periodic_sec))))&&((this.noConfigAck == rhs.noConfigAck)||((this.noConfigAck!= null)&&this.noConfigAck.equals(rhs.noConfigAck))))&&((this.recv_id == rhs.recv_id)||((this.recv_id!= null)&&this.recv_id.equals(rhs.recv_id))))&&((this.gatewayId == rhs.gatewayId)||((this.gatewayId!= null)&&this.gatewayId.equals(rhs.gatewayId))))&&((this.auth_provider == rhs.auth_provider)||((this.auth_provider!= null)&&this.auth_provider.equals(rhs.auth_provider))))&&((this.algorithm == rhs.algorithm)||((this.algorithm!= null)&&this.algorithm.equals(rhs.algorithm)))); } public enum Protocol { diff --git a/gencode/java/udmi/schema/Events.java b/gencode/java/udmi/schema/Events.java index 280293bc37..a431206d31 100644 --- a/gencode/java/udmi/schema/Events.java +++ b/gencode/java/udmi/schema/Events.java @@ -53,8 +53,8 @@ public class Events { public int hashCode() { int result = 1; result = ((result* 31)+((this.pointset == null)? 0 :this.pointset.hashCode())); - result = ((result* 31)+((this.system == null)? 0 :this.system.hashCode())); result = ((result* 31)+((this.discovery == null)? 0 :this.discovery.hashCode())); + result = ((result* 31)+((this.system == null)? 0 :this.system.hashCode())); return result; } @@ -67,7 +67,7 @@ public boolean equals(Object other) { return false; } Events rhs = ((Events) other); - return ((((this.pointset == rhs.pointset)||((this.pointset!= null)&&this.pointset.equals(rhs.pointset)))&&((this.system == rhs.system)||((this.system!= null)&&this.system.equals(rhs.system))))&&((this.discovery == rhs.discovery)||((this.discovery!= null)&&this.discovery.equals(rhs.discovery)))); + return ((((this.pointset == rhs.pointset)||((this.pointset!= null)&&this.pointset.equals(rhs.pointset)))&&((this.discovery == rhs.discovery)||((this.discovery!= null)&&this.discovery.equals(rhs.discovery))))&&((this.system == rhs.system)||((this.system!= null)&&this.system.equals(rhs.system)))); } } diff --git a/gencode/java/udmi/schema/GatewayModel.java b/gencode/java/udmi/schema/GatewayModel.java index 22876706e5..f474d979a9 100644 --- a/gencode/java/udmi/schema/GatewayModel.java +++ b/gencode/java/udmi/schema/GatewayModel.java @@ -49,8 +49,8 @@ public class GatewayModel { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.proxy_ids == null)? 0 :this.proxy_ids.hashCode())); result = ((result* 31)+((this.gateway_id == null)? 0 :this.gateway_id.hashCode())); + result = ((result* 31)+((this.proxy_ids == null)? 0 :this.proxy_ids.hashCode())); result = ((result* 31)+((this.target == null)? 0 :this.target.hashCode())); return result; } @@ -64,7 +64,7 @@ public boolean equals(Object other) { return false; } GatewayModel rhs = ((GatewayModel) other); - return ((((this.proxy_ids == rhs.proxy_ids)||((this.proxy_ids!= null)&&this.proxy_ids.equals(rhs.proxy_ids)))&&((this.gateway_id == rhs.gateway_id)||((this.gateway_id!= null)&&this.gateway_id.equals(rhs.gateway_id))))&&((this.target == rhs.target)||((this.target!= null)&&this.target.equals(rhs.target)))); + return ((((this.gateway_id == rhs.gateway_id)||((this.gateway_id!= null)&&this.gateway_id.equals(rhs.gateway_id)))&&((this.proxy_ids == rhs.proxy_ids)||((this.proxy_ids!= null)&&this.proxy_ids.equals(rhs.proxy_ids))))&&((this.target == rhs.target)||((this.target!= null)&&this.target.equals(rhs.target)))); } } diff --git a/gencode/java/udmi/schema/Metadata.java b/gencode/java/udmi/schema/Metadata.java index cabbe1cc86..22c9353077 100644 --- a/gencode/java/udmi/schema/Metadata.java +++ b/gencode/java/udmi/schema/Metadata.java @@ -22,6 +22,7 @@ "version", "upgraded_from", "hash", + "operation", "cloud", "system", "gateway", @@ -64,6 +65,14 @@ public class Metadata { @JsonProperty("hash") @JsonPropertyDescription("Automatically generated field that contains the hash of file contents.") public java.lang.String hash; + /** + * Model Operation + *

+ * + * + */ + @JsonProperty("operation") + public CloudModel.ModelOperation operation; /** * Cloud Model *

@@ -152,6 +161,7 @@ public int hashCode() { result = ((result* 31)+((this.discovery == null)? 0 :this.discovery.hashCode())); result = ((result* 31)+((this.upgraded_from == null)? 0 :this.upgraded_from.hashCode())); result = ((result* 31)+((this.pointset == null)? 0 :this.pointset.hashCode())); + result = ((result* 31)+((this.operation == null)? 0 :this.operation.hashCode())); result = ((result* 31)+((this.hash == null)? 0 :this.hash.hashCode())); result = ((result* 31)+((this.gateway == null)? 0 :this.gateway.hashCode())); result = ((result* 31)+((this.localnet == null)? 0 :this.localnet.hashCode())); @@ -168,7 +178,7 @@ public boolean equals(Object other) { return false; } Metadata rhs = ((Metadata) other); - return ((((((((((((((this.testing == rhs.testing)||((this.testing!= null)&&this.testing.equals(rhs.testing)))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.structure == rhs.structure)||((this.structure!= null)&&this.structure.equals(rhs.structure))))&&((this.cloud == rhs.cloud)||((this.cloud!= null)&&this.cloud.equals(rhs.cloud))))&&((this.features == rhs.features)||((this.features!= null)&&this.features.equals(rhs.features))))&&((this.system == rhs.system)||((this.system!= null)&&this.system.equals(rhs.system))))&&((this.discovery == rhs.discovery)||((this.discovery!= null)&&this.discovery.equals(rhs.discovery))))&&((this.upgraded_from == rhs.upgraded_from)||((this.upgraded_from!= null)&&this.upgraded_from.equals(rhs.upgraded_from))))&&((this.pointset == rhs.pointset)||((this.pointset!= null)&&this.pointset.equals(rhs.pointset))))&&((this.hash == rhs.hash)||((this.hash!= null)&&this.hash.equals(rhs.hash))))&&((this.gateway == rhs.gateway)||((this.gateway!= null)&&this.gateway.equals(rhs.gateway))))&&((this.localnet == rhs.localnet)||((this.localnet!= null)&&this.localnet.equals(rhs.localnet))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp)))); + return (((((((((((((((this.testing == rhs.testing)||((this.testing!= null)&&this.testing.equals(rhs.testing)))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.structure == rhs.structure)||((this.structure!= null)&&this.structure.equals(rhs.structure))))&&((this.cloud == rhs.cloud)||((this.cloud!= null)&&this.cloud.equals(rhs.cloud))))&&((this.features == rhs.features)||((this.features!= null)&&this.features.equals(rhs.features))))&&((this.system == rhs.system)||((this.system!= null)&&this.system.equals(rhs.system))))&&((this.discovery == rhs.discovery)||((this.discovery!= null)&&this.discovery.equals(rhs.discovery))))&&((this.upgraded_from == rhs.upgraded_from)||((this.upgraded_from!= null)&&this.upgraded_from.equals(rhs.upgraded_from))))&&((this.pointset == rhs.pointset)||((this.pointset!= null)&&this.pointset.equals(rhs.pointset))))&&((this.operation == rhs.operation)||((this.operation!= null)&&this.operation.equals(rhs.operation))))&&((this.hash == rhs.hash)||((this.hash!= null)&&this.hash.equals(rhs.hash))))&&((this.gateway == rhs.gateway)||((this.gateway!= null)&&this.gateway.equals(rhs.gateway))))&&((this.localnet == rhs.localnet)||((this.localnet!= null)&&this.localnet.equals(rhs.localnet))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp)))); } } diff --git a/gencode/java/udmi/schema/RefDiscovery.java b/gencode/java/udmi/schema/RefDiscovery.java index e50aeb6bf9..7bdebeeda7 100644 --- a/gencode/java/udmi/schema/RefDiscovery.java +++ b/gencode/java/udmi/schema/RefDiscovery.java @@ -113,17 +113,17 @@ public class RefDiscovery { @Override public int hashCode() { int result = 1; + result = ((result* 31)+((this.ref == null)? 0 :this.ref.hashCode())); + result = ((result* 31)+((this.possible_values == null)? 0 :this.possible_values.hashCode())); + result = ((result* 31)+((this.name == null)? 0 :this.name.hashCode())); result = ((result* 31)+((this.description == null)? 0 :this.description.hashCode())); result = ((result* 31)+((this.units == null)? 0 :this.units.hashCode())); result = ((result* 31)+((this.type == null)? 0 :this.type.hashCode())); + result = ((result* 31)+((this.ancillary == null)? 0 :this.ancillary.hashCode())); + result = ((result* 31)+((this.adjunct == null)? 0 :this.adjunct.hashCode())); result = ((result* 31)+((this.point == null)? 0 :this.point.hashCode())); result = ((result* 31)+((this.structure == null)? 0 :this.structure.hashCode())); result = ((result* 31)+((this.writable == null)? 0 :this.writable.hashCode())); - result = ((result* 31)+((this.ref == null)? 0 :this.ref.hashCode())); - result = ((result* 31)+((this.possible_values == null)? 0 :this.possible_values.hashCode())); - result = ((result* 31)+((this.name == null)? 0 :this.name.hashCode())); - result = ((result* 31)+((this.ancillary == null)? 0 :this.ancillary.hashCode())); - result = ((result* 31)+((this.adjunct == null)? 0 :this.adjunct.hashCode())); result = ((result* 31)+((this.status == null)? 0 :this.status.hashCode())); return result; } @@ -137,7 +137,7 @@ public boolean equals(java.lang.Object other) { return false; } RefDiscovery rhs = ((RefDiscovery) other); - return (((((((((((((this.description == rhs.description)||((this.description!= null)&&this.description.equals(rhs.description)))&&((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units))))&&((this.type == rhs.type)||((this.type!= null)&&this.type.equals(rhs.type))))&&((this.point == rhs.point)||((this.point!= null)&&this.point.equals(rhs.point))))&&((this.structure == rhs.structure)||((this.structure!= null)&&this.structure.equals(rhs.structure))))&&((this.writable == rhs.writable)||((this.writable!= null)&&this.writable.equals(rhs.writable))))&&((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref))))&&((this.possible_values == rhs.possible_values)||((this.possible_values!= null)&&this.possible_values.equals(rhs.possible_values))))&&((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name))))&&((this.ancillary == rhs.ancillary)||((this.ancillary!= null)&&this.ancillary.equals(rhs.ancillary))))&&((this.adjunct == rhs.adjunct)||((this.adjunct!= null)&&this.adjunct.equals(rhs.adjunct))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status)))); + return (((((((((((((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref)))&&((this.possible_values == rhs.possible_values)||((this.possible_values!= null)&&this.possible_values.equals(rhs.possible_values))))&&((this.name == rhs.name)||((this.name!= null)&&this.name.equals(rhs.name))))&&((this.description == rhs.description)||((this.description!= null)&&this.description.equals(rhs.description))))&&((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units))))&&((this.type == rhs.type)||((this.type!= null)&&this.type.equals(rhs.type))))&&((this.ancillary == rhs.ancillary)||((this.ancillary!= null)&&this.ancillary.equals(rhs.ancillary))))&&((this.adjunct == rhs.adjunct)||((this.adjunct!= null)&&this.adjunct.equals(rhs.adjunct))))&&((this.point == rhs.point)||((this.point!= null)&&this.point.equals(rhs.point))))&&((this.structure == rhs.structure)||((this.structure!= null)&&this.structure.equals(rhs.structure))))&&((this.writable == rhs.writable)||((this.writable!= null)&&this.writable.equals(rhs.writable))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status)))); } } diff --git a/gencode/java/udmi/schema/SiteLinks.java b/gencode/java/udmi/schema/SiteLinks.java index 41fc94ca6c..3f3527402e 100644 --- a/gencode/java/udmi/schema/SiteLinks.java +++ b/gencode/java/udmi/schema/SiteLinks.java @@ -71,11 +71,11 @@ public class SiteLinks { public int hashCode() { int result = 1; result = ((result* 31)+((this.image == null)? 0 :this.image.hashCode())); + result = ((result* 31)+((this.sheet == null)? 0 :this.sheet.hashCode())); result = ((result* 31)+((this.folder == null)? 0 :this.folder.hashCode())); result = ((result* 31)+((this.docs == null)? 0 :this.docs.hashCode())); - result = ((result* 31)+((this.repo == null)? 0 :this.repo.hashCode())); - result = ((result* 31)+((this.sheet == null)? 0 :this.sheet.hashCode())); result = ((result* 31)+((this.dashboard == null)? 0 :this.dashboard.hashCode())); + result = ((result* 31)+((this.repo == null)? 0 :this.repo.hashCode())); return result; } @@ -88,7 +88,7 @@ public boolean equals(Object other) { return false; } SiteLinks rhs = ((SiteLinks) other); - return (((((((this.image == rhs.image)||((this.image!= null)&&this.image.equals(rhs.image)))&&((this.folder == rhs.folder)||((this.folder!= null)&&this.folder.equals(rhs.folder))))&&((this.docs == rhs.docs)||((this.docs!= null)&&this.docs.equals(rhs.docs))))&&((this.repo == rhs.repo)||((this.repo!= null)&&this.repo.equals(rhs.repo))))&&((this.sheet == rhs.sheet)||((this.sheet!= null)&&this.sheet.equals(rhs.sheet))))&&((this.dashboard == rhs.dashboard)||((this.dashboard!= null)&&this.dashboard.equals(rhs.dashboard)))); + return (((((((this.image == rhs.image)||((this.image!= null)&&this.image.equals(rhs.image)))&&((this.sheet == rhs.sheet)||((this.sheet!= null)&&this.sheet.equals(rhs.sheet))))&&((this.folder == rhs.folder)||((this.folder!= null)&&this.folder.equals(rhs.folder))))&&((this.docs == rhs.docs)||((this.docs!= null)&&this.docs.equals(rhs.docs))))&&((this.dashboard == rhs.dashboard)||((this.dashboard!= null)&&this.dashboard.equals(rhs.dashboard))))&&((this.repo == rhs.repo)||((this.repo!= null)&&this.repo.equals(rhs.repo)))); } } diff --git a/gencode/java/udmi/schema/SiteLocation.java b/gencode/java/udmi/schema/SiteLocation.java index 1318d4e57e..c49ba57283 100644 --- a/gencode/java/udmi/schema/SiteLocation.java +++ b/gencode/java/udmi/schema/SiteLocation.java @@ -46,9 +46,9 @@ public class SiteLocation { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.address == null)? 0 :this.address.hashCode())); result = ((result* 31)+((this.lat == null)? 0 :this.lat.hashCode())); result = ((result* 31)+((this._long == null)? 0 :this._long.hashCode())); + result = ((result* 31)+((this.address == null)? 0 :this.address.hashCode())); return result; } @@ -61,7 +61,7 @@ public boolean equals(Object other) { return false; } SiteLocation rhs = ((SiteLocation) other); - return ((((this.address == rhs.address)||((this.address!= null)&&this.address.equals(rhs.address)))&&((this.lat == rhs.lat)||((this.lat!= null)&&this.lat.equals(rhs.lat))))&&((this._long == rhs._long)||((this._long!= null)&&this._long.equals(rhs._long)))); + return ((((this.lat == rhs.lat)||((this.lat!= null)&&this.lat.equals(rhs.lat)))&&((this._long == rhs._long)||((this._long!= null)&&this._long.equals(rhs._long))))&&((this.address == rhs.address)||((this.address!= null)&&this.address.equals(rhs.address)))); } } diff --git a/gencode/python/udmi/schema/common.py b/gencode/python/udmi/schema/common.py index c19a1db01c..d1a54b0e2d 100644 --- a/gencode/python/udmi/schema/common.py +++ b/gencode/python/udmi/schema/common.py @@ -8,6 +8,7 @@ class Common: SystemMode = SystemMode ProtocolFamily = ProtocolFamily IotProvider = IotProvider + ModelOperation = ModelOperation FeatureStage = FeatureStage BlobPhase = BlobPhase SystemBlobsets = SystemBlobsets diff --git a/gencode/python/udmi/schema/metadata.py b/gencode/python/udmi/schema/metadata.py index 7ae489d74d..57ea6c507d 100644 --- a/gencode/python/udmi/schema/metadata.py +++ b/gencode/python/udmi/schema/metadata.py @@ -18,6 +18,7 @@ def __init__(self): self.version = None self.upgraded_from = None self.hash = None + self.operation = None self.cloud = None self.system = None self.gateway = None @@ -37,6 +38,7 @@ def from_dict(source): result.version = source.get('version') result.upgraded_from = source.get('upgraded_from') result.hash = source.get('hash') + result.operation = source.get('operation') result.cloud = CloudModel.from_dict(source.get('cloud')) result.system = SystemModel.from_dict(source.get('system')) result.gateway = GatewayModel.from_dict(source.get('gateway')) @@ -74,6 +76,8 @@ def to_dict(self): result['upgraded_from'] = self.upgraded_from # 5 if self.hash: result['hash'] = self.hash # 5 + if self.operation: + result['operation'] = self.operation # 5 if self.cloud: result['cloud'] = self.cloud.to_dict() # 4 if self.system: diff --git a/schema/common.json b/schema/common.json index 0a61b2d595..04de8ec22f 100644 --- a/schema/common.json +++ b/schema/common.json @@ -48,6 +48,24 @@ "clearblade" ] }, + "operation": { + "title": "Model Operation", + "enum": [ + "ERROR", + "CREATE", + "READ", + "REPLY", + "UPDATE", + "DELETE", + "MODIFY", + "PREVIEW", + "BIND", + "UNBIND", + "BOUND", + "ALLOW", + "BLOCK" + ] + }, "stage": { "title": "FeatureStage", "description": "Stage of a feature implemenation", diff --git a/schema/metadata.json b/schema/metadata.json index 9d72e518a1..fae43d890f 100644 --- a/schema/metadata.json +++ b/schema/metadata.json @@ -31,6 +31,10 @@ "type": "string", "pattern": "^[0-9a-z]{8}$" }, + "operation": { + "description": "Used for model update operations (so not a model proper), e.g. DELETE or BIND operations", + "$ref": "file:common.json#/definitions/operation" + }, "cloud": { "$ref": "file:model_cloud.json#" }, diff --git a/schema/model_cloud.json b/schema/model_cloud.json index 211348c0f1..d699d3122d 100644 --- a/schema/model_cloud.json +++ b/schema/model_cloud.json @@ -109,21 +109,7 @@ "type": "string" }, "operation": { - "enum": [ - "ERROR", - "CREATE", - "READ", - "REPLY", - "UPDATE", - "DELETE", - "MODIFY", - "PREVIEW", - "BIND", - "UNBIND", - "BOUND", - "ALLOW", - "BLOCK" - ] + "$ref": "file:common.json#/definitions/operation" }, "metadata": { "type": "object", diff --git a/udmis/src/main/java/com/google/bos/udmi/service/access/ClearBladeIotAccessProvider.java b/udmis/src/main/java/com/google/bos/udmi/service/access/ClearBladeIotAccessProvider.java index 5ecbac323e..56f628586a 100644 --- a/udmis/src/main/java/com/google/bos/udmi/service/access/ClearBladeIotAccessProvider.java +++ b/udmis/src/main/java/com/google/bos/udmi/service/access/ClearBladeIotAccessProvider.java @@ -21,11 +21,11 @@ import static java.util.Objects.requireNonNull; import static java.util.Optional.ofNullable; import static java.util.stream.Collectors.toMap; -import static udmi.schema.CloudModel.Operation.BIND; -import static udmi.schema.CloudModel.Operation.BOUND; -import static udmi.schema.CloudModel.Operation.CREATE; -import static udmi.schema.CloudModel.Operation.DELETE; -import static udmi.schema.CloudModel.Operation.UPDATE; +import static udmi.schema.CloudModel.ModelOperation.BIND; +import static udmi.schema.CloudModel.ModelOperation.BOUND; +import static udmi.schema.CloudModel.ModelOperation.CREATE; +import static udmi.schema.CloudModel.ModelOperation.DELETE; +import static udmi.schema.CloudModel.ModelOperation.UPDATE; import static udmi.schema.CloudModel.Resource_type.DEVICE; import static udmi.schema.CloudModel.Resource_type.GATEWAY; import static udmi.schema.CloudModel.Resource_type.REGISTRY; @@ -95,7 +95,7 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.Credential; import udmi.schema.Credential.Key_format; @@ -288,7 +288,7 @@ private CloudModel blockDevice(String registryId, Device device) { .setUpdateMask(BLOCKED_FIELD_MASK).build(); requireNonNull(deviceManager.updateDevice(request), "Invalid RPC response"); CloudModel cloudModel = new CloudModel(); - cloudModel.operation = Operation.BLOCK; + cloudModel.operation = ModelOperation.BLOCK; cloudModel.num_id = hashedDeviceId(registryId, deviceId); return cloudModel; } catch (Exception e) { @@ -308,7 +308,7 @@ private Device convert(CloudModel cloudModel, String deviceId) { .build(); } - private CloudModel convert(Empty execute, Operation operation) { + private CloudModel convert(Empty execute, ModelOperation operation) { CloudModel cloudModel = new CloudModel(); cloudModel.operation = operation; cloudModel.num_id = EMPTY_RETURN_RECEIPT; @@ -563,7 +563,7 @@ private GatewayModel makeGatewayModel(HashMap boundDevices) public CloudModel modelDevice(String registryId, String deviceId, CloudModel cloudModel, Consumer progress) { String devicePath = getDeviceName(registryId, deviceId); - Operation operation = cloudModel.operation; + ModelOperation operation = cloudModel.operation; Resource_type type = ofNullable(cloudModel.resource_type).orElse(Resource_type.DEVICE); checkState(type == DEVICE || type == GATEWAY, "unexpected resource type " + type); try { @@ -592,7 +592,7 @@ private CloudModel getReply(String registryId, String deviceId, CloudModel reque @Override public CloudModel modelRegistry(String registryId, String deviceId, CloudModel cloudModel) { - Operation operation = cloudModel.operation; + ModelOperation operation = cloudModel.operation; String registryActual = registryId + deviceId; try { if (operation == UPDATE) { @@ -623,7 +623,7 @@ private CloudModel modifyDevice(String registryId, Device device) { model.metadata.putAll(builder.getMetadata()); builder.setMetadata(model.metadata); CloudModel cloudModel = updateDevice(registryId, builder.build(), METADATA_FIELD_MASK); - cloudModel.operation = Operation.MODIFY; + cloudModel.operation = ModelOperation.MODIFY; cloudModel.gateway = model.gateway; cloudModel.device_ids = model.device_ids; return cloudModel; @@ -805,7 +805,7 @@ public CloudModel fetchDevice(String registryId, String deviceId) { Device device = deviceManager.getDevice(request); requireNonNull(device, "GetDeviceRequest failed"); CloudModel cloudModel = convertFull(device); - cloudModel.operation = Operation.READ; + cloudModel.operation = ModelOperation.READ; cloudModel.gateway = fetchDeviceGatewayModel(registryId, deviceId, device); return cloudModel; } catch (Exception e) { diff --git a/udmis/src/main/java/com/google/bos/udmi/service/access/ImplicitIotAccessProvider.java b/udmis/src/main/java/com/google/bos/udmi/service/access/ImplicitIotAccessProvider.java index b37cc6a940..060773d308 100644 --- a/udmis/src/main/java/com/google/bos/udmi/service/access/ImplicitIotAccessProvider.java +++ b/udmis/src/main/java/com/google/bos/udmi/service/access/ImplicitIotAccessProvider.java @@ -21,8 +21,8 @@ import static java.util.Objects.requireNonNull; import static java.util.Optional.ofNullable; import static java.util.function.Predicate.not; -import static udmi.schema.CloudModel.Operation.DELETE; -import static udmi.schema.CloudModel.Operation.READ; +import static udmi.schema.CloudModel.ModelOperation.DELETE; +import static udmi.schema.CloudModel.ModelOperation.READ; import static udmi.schema.CloudModel.Resource_type.DEVICE; import static udmi.schema.CloudModel.Resource_type.GATEWAY; @@ -51,7 +51,7 @@ import java.util.function.Consumer; import java.util.stream.Collectors; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.Credential; import udmi.schema.Credential.Key_format; @@ -327,7 +327,7 @@ private Map listBoundDevices(String registryId, String gatew @Override public CloudModel modelDevice(String registryId, String deviceId, CloudModel cloudModel, Consumer progress) { - Operation operation = cloudModel.operation; + ModelOperation operation = cloudModel.operation; Resource_type type = ofNullable(cloudModel.resource_type).orElse(Resource_type.DEVICE); checkState(type == DEVICE || type == GATEWAY, "unexpected resource type " + type); try { @@ -350,7 +350,7 @@ public CloudModel modelDevice(String registryId, String deviceId, CloudModel clo @Override public CloudModel modelRegistry(String registryId, String deviceId, CloudModel cloudModel) { - Operation operation = cloudModel.operation; + ModelOperation operation = cloudModel.operation; try { // TODO: Make this update the saved metadata for the registry. return getReply(registryId, deviceId, cloudModel, "registry"); diff --git a/udmis/src/main/java/com/google/bos/udmi/service/core/ProvisioningEngine.java b/udmis/src/main/java/com/google/bos/udmi/service/core/ProvisioningEngine.java index d95afd6315..988d6f6932 100644 --- a/udmis/src/main/java/com/google/bos/udmi/service/core/ProvisioningEngine.java +++ b/udmis/src/main/java/com/google/bos/udmi/service/core/ProvisioningEngine.java @@ -15,7 +15,7 @@ import static com.google.udmi.util.MetadataMapKeys.UDMI_UPDATED; import static java.lang.String.format; import static java.util.Objects.requireNonNull; -import static udmi.schema.CloudModel.Operation.BIND; +import static udmi.schema.CloudModel.ModelOperation.BIND; import java.util.Date; import java.util.HashMap; @@ -26,7 +26,7 @@ import java.util.function.Consumer; import java.util.function.Supplier; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.DiscoveryEvents; import udmi.schema.EndpointConfiguration; @@ -58,7 +58,7 @@ private void bindDeviceToGateway(String registryId, String proxyId, String gatew private void createDeviceEntry(String registryId, String expectedId, String gatewayId, Envelope envelope, DiscoveryEvents discoveryEvent) { CloudModel cloudModel = new CloudModel(); - cloudModel.operation = Operation.CREATE; + cloudModel.operation = ModelOperation.CREATE; cloudModel.blocked = true; ifNullThen(cloudModel.metadata, () -> cloudModel.metadata = new HashMap<>()); cloudModel.metadata.put(UDMI_DISCOVERED_FROM, stringifyTerse(envelope)); diff --git a/udmis/src/main/java/com/google/bos/udmi/service/core/ReflectProcessor.java b/udmis/src/main/java/com/google/bos/udmi/service/core/ReflectProcessor.java index 23e3a3b643..4e9360e51f 100644 --- a/udmis/src/main/java/com/google/bos/udmi/service/core/ReflectProcessor.java +++ b/udmis/src/main/java/com/google/bos/udmi/service/core/ReflectProcessor.java @@ -38,8 +38,8 @@ import static java.lang.String.format; import static java.util.Objects.requireNonNull; import static java.util.Optional.ofNullable; -import static udmi.schema.CloudModel.Operation.PREVIEW; -import static udmi.schema.CloudModel.Operation.READ; +import static udmi.schema.CloudModel.ModelOperation.PREVIEW; +import static udmi.schema.CloudModel.ModelOperation.READ; import static udmi.schema.CloudModel.Resource_type.REGISTRY; import static udmi.schema.Envelope.SubFolder.UPDATE; import static udmi.schema.IotAccess.IotProvider.IMPLICIT; @@ -59,7 +59,7 @@ import java.util.Objects; import java.util.stream.Collectors; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.EndpointConfiguration; import udmi.schema.Entry; import udmi.schema.Envelope; @@ -323,7 +323,7 @@ private Envelope makeTargetEnvelope(Envelope attributes) { private ModelUpdate asModelUpdate(CloudModel request) { ModelUpdate modelUpdate = new ModelUpdate(); - modelUpdate.cloud = request; + modelUpdate.operation = request.operation; return modelUpdate; } @@ -342,7 +342,7 @@ private ModelUpdate asModelUpdate(String modelString) { private CloudModel reflectProcess(Envelope attributes, Object payload) { CloudModel reply = new CloudModel(); - reply.operation = Operation.REPLY; + reply.operation = ModelOperation.REPLY; if (payload == null) { return reply; } diff --git a/udmis/src/test/java/com/google/bos/udmi/service/core/ProvisioningEngineTest.java b/udmis/src/test/java/com/google/bos/udmi/service/core/ProvisioningEngineTest.java index fa18ec1bd4..66e722a877 100644 --- a/udmis/src/test/java/com/google/bos/udmi/service/core/ProvisioningEngineTest.java +++ b/udmis/src/test/java/com/google/bos/udmi/service/core/ProvisioningEngineTest.java @@ -29,7 +29,7 @@ import org.mockito.ArgumentCaptor; import udmi.lib.ProtocolFamily; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.DiscoveryEvents; import udmi.schema.Envelope; @@ -131,11 +131,11 @@ public void discoveryEventCreate() { List models = modelCaptor.getAllValues(); assertEquals(DISCOVERED_DEVICE, devices.get(0), "created device id"); - assertEquals(Operation.CREATE, models.get(0).operation, "operation mismatch"); + assertEquals(ModelOperation.CREATE, models.get(0).operation, "operation mismatch"); assertTrue(models.get(0).blocked, "device blocked"); assertEquals(TEST_GATEWAY, devices.get(1), "scanning gateway id"); - assertEquals(Operation.BIND, models.get(1).operation, "operation mismatch"); + assertEquals(ModelOperation.BIND, models.get(1).operation, "operation mismatch"); assertNotNull(models.get(1).device_ids.get(DISCOVERED_DEVICE), "binding device entry"); } diff --git a/udmis/src/test/java/com/google/bos/udmi/service/core/ReflectProcessorTest.java b/udmis/src/test/java/com/google/bos/udmi/service/core/ReflectProcessorTest.java index 1aae699ff6..5e570aad87 100644 --- a/udmis/src/test/java/com/google/bos/udmi/service/core/ReflectProcessorTest.java +++ b/udmis/src/test/java/com/google/bos/udmi/service/core/ReflectProcessorTest.java @@ -29,7 +29,7 @@ import org.junit.jupiter.api.Test; import org.mockito.ArgumentCaptor; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.Envelope; import udmi.schema.Envelope.SubFolder; @@ -152,12 +152,12 @@ public void invalidInitExchange() { @Test public void modelDeviceTest() { CloudModel returnModel = new CloudModel(); - returnModel.operation = Operation.CREATE; + returnModel.operation = ModelOperation.CREATE; returnModel.resource_type = Resource_type.DEVICE; when(provider.modelDevice(anyString(), anyString(), notNull(), any())).thenReturn(returnModel); CloudModel requestModel = new CloudModel(); - requestModel.operation = Operation.BIND; + requestModel.operation = ModelOperation.BIND; requestModel.resource_type = Resource_type.DEVICE; activeTestInstance(() -> getReverseDispatcher().publish(makeModelBundle(requestModel))); verify(provider, times(1)).modelDevice(eq(TEST_REGISTRY), eq(TEST_DEVICE), @@ -173,7 +173,7 @@ public void modelDeviceTest() { @Test public void modelRegistryUpdateTest() { CloudModel requestModel = new CloudModel(); - requestModel.operation = Operation.UPDATE; + requestModel.operation = ModelOperation.UPDATE; requestModel.resource_type = Resource_type.REGISTRY; activeTestInstance(() -> getReverseDispatcher().publish(makeModelBundle(requestModel))); verify(provider, times(1)).modelRegistry(eq(TEST_REGISTRY), any(), diff --git a/udmis/udmis.iml b/udmis/udmis.iml index 057b2445b1..8d2fbc6800 100644 --- a/udmis/udmis.iml +++ b/udmis/udmis.iml @@ -26,9 +26,12 @@ + + + @@ -47,12 +50,15 @@ + + + @@ -61,10 +67,12 @@ - - - + + + + + @@ -72,7 +80,12 @@ + + + + + @@ -98,8 +111,13 @@ + + + + + From d4a97df1218272bbf63615453a9355bc27e2bb62 Mon Sep 17 00:00:00 2001 From: Noureddine Date: Wed, 19 Feb 2025 14:49:47 +0000 Subject: [PATCH 2/8] python 3.12 gencode support --- .gencode_hash.txt | 54 +- etc/requirements.txt | 14 +- gencode/docs/commands_discovery.html | 30 +- gencode/docs/commands_mapping.html | 444 +-- gencode/docs/config.html | 628 +-- gencode/docs/config_mapping.html | 430 +- gencode/docs/configuration_endpoint.html | 258 +- gencode/docs/configuration_execution.html | 796 ++-- gencode/docs/configuration_pod.html | 1524 +++---- gencode/docs/configuration_pubber.html | 678 ++-- gencode/docs/data_template.html | 20 +- gencode/docs/events.html | 3234 +++++++-------- gencode/docs/events_discovery.html | 2690 ++++++------- gencode/docs/events_mapping.html | 566 +-- gencode/docs/events_pointset.html | 76 +- gencode/docs/events_system.html | 462 +-- gencode/docs/events_udmi.html | 388 +- gencode/docs/events_validation.html | 796 ++-- gencode/docs/metadata.html | 4432 ++++++++++----------- gencode/docs/monitoring.html | 618 +-- gencode/docs/persistent_device.html | 284 +- gencode/docs/properties.html | 48 +- gencode/docs/query_cloud.html | 54 +- gencode/docs/schema_doc.css | 3 +- gencode/docs/schema_doc.min.js | 2 +- gencode/docs/site_metadata.html | 874 ++-- gencode/docs/state.html | 2910 +++++++------- gencode/docs/state_mapping.html | 442 +- gencode/docs/state_validation.html | 2768 ++++++------- 29 files changed, 12762 insertions(+), 12761 deletions(-) diff --git a/.gencode_hash.txt b/.gencode_hash.txt index 97ee9f4a9f..2be5029869 100644 --- a/.gencode_hash.txt +++ b/.gencode_hash.txt @@ -1,32 +1,32 @@ -433b3c972a2d4de6f54cf32f00f918fa7e3fd80d4bf29a2c7bee182f532bc660 gencode/docs/commands_discovery.html -158e714e54b2a6d0b90bfca00d178369b04508dc4fa84a979690a813ca2dd724 gencode/docs/commands_mapping.html -91f3b8ac9cdaea7c1c96b90484f9d0e856dde691f282dd9ab2953ed1ddaaf31a gencode/docs/config.html -22bfb3fd7c0e73dac4cbd830aa7983714917ec6da813f6bf5768ce3aa9786fb2 gencode/docs/config_mapping.html -f9a67145928e192687c7984c82c2d39450bf6d0d4fd2f95f397e60e8ac619da2 gencode/docs/configuration_endpoint.html -8ac76a1b8c0c62f19be8cafa36b1f58bc03f3f129e10def91566d0b9172b0c82 gencode/docs/configuration_execution.html -ed7a8b71e2a0b002151a1a5fa0c038f1af811f7567250c724ac3c4b245ccc6b4 gencode/docs/configuration_pod.html -e13c6cf75686d5a200543247651fbf41c302d052d91dd3bc59212c90fb915dc4 gencode/docs/configuration_pubber.html -f24d15e549f1b143b50d6011f2f7fd03286e1cd128a3e25591195b25f8efc472 gencode/docs/data_template.html -9c7b71623e57e8a516c86578f431dc1b259c3a70b06c521d1f088304e11daeb9 gencode/docs/events.html -3254f692709b6a5a331f096d6c33ceac0f2ad23f563ba7c21acf93741950c338 gencode/docs/events_discovery.html -65858e981eaad27e41fd7f64aae7d6a82d4519e798145eb10898e59cead517c3 gencode/docs/events_mapping.html -c3bae844432d172033bc416e623fecee7608efd01d916b7eaee96252932c552a gencode/docs/events_pointset.html -d001ca2ede044a183ef25617e6d7bd87840695d0b2aeb03a0d3d7b8d7bbebe42 gencode/docs/events_system.html -e59e52110ec12d7b82351abfc28c31255c57e2af637adf3fa5cbb7e3b26b49fe gencode/docs/events_udmi.html -e3683cb4561b6dda5703cb659fd6a8f12242725de389709a12eb45f146cbb295 gencode/docs/events_validation.html -d4413ddbaa61efdade1c27cbc78c5bc3d6a206ee7d421f555635b7f52617c107 gencode/docs/metadata.html -424f8e053c5a7002c4117a70bd84731e3bb6e0f696b607aba412c2aee44d9f91 gencode/docs/monitoring.html -3421bdc8c63872fb47795993a2d21da0d03a7ec4e6de0ac7cfe7a48ef60e743b gencode/docs/persistent_device.html -5d039d607af9ec75ee552dfe36b16c702687ea16f5663f41fc49b4533b86e00d gencode/docs/properties.html -8a266fc0fcbba7565cfe1e1cbddd7b2cbe0c8c1f5bfd2aa9f3b862ed7e3f0706 gencode/docs/query_cloud.html +c21266e8de23b6e8acfac16a177db782375bf71df470c343c3f8eb8b822ef56a gencode/docs/commands_discovery.html +7bd462fd9b31a1a35b27f069194051161c484600161d7ef3fa7a4f8efa4e65fb gencode/docs/commands_mapping.html +7cf3a6c93a457eefbe95b2ecbd55d89139343449b3554ac1d8f7653b02bb4cc3 gencode/docs/config.html +284b682ff2388abdeddf30fb88d15501b2fa22e36c8161a8373cfb7651530817 gencode/docs/config_mapping.html +0bb798c8db6be37266946569a096e2f0b7520ee54d65e7e8d37675ef17820f14 gencode/docs/configuration_endpoint.html +d6a260ed6dca30f85d18ca7c96421d1a70204816b4fd382cca1716e18ed506e8 gencode/docs/configuration_execution.html +11b21f73b6a4065102968a4c09979639b8a7ea6efb20e40d52cd21b2a60167bb gencode/docs/configuration_pod.html +01495c82f15040bb307cbfd39e0bbc7af21ce0d70008cbd19878a9046dcda814 gencode/docs/configuration_pubber.html +1057fa40fb7a31a23bb2773d21c38cf4590a935bd8b5ea4218e695c6204f5dd9 gencode/docs/data_template.html +23948cddb6c580547ec8731414d814256cb1c2488d362b1fabc5a88cada3ab85 gencode/docs/events.html +39f92aeb39f5be8c152389664315de9e54a070022956a88e048cff892addb485 gencode/docs/events_discovery.html +e550539d52ce1f63b35247d425c038e5d5ba33f997eedd09e486a3bd9838c2c2 gencode/docs/events_mapping.html +66e19faae60f9502749391889dbe24bd709963e658b61d989c7ba780672fa447 gencode/docs/events_pointset.html +cac253f57c5c92ef32e2a5f91b6cec8229e8db1dcffcc96a58f06da068e741e7 gencode/docs/events_system.html +151c1b62db35e84e51d5ff2a7464f61ced4d7fb0c7eb795715c245ee0a1b3436 gencode/docs/events_udmi.html +73dbe799e7943ec20ac58b544998e986a39539d4ef0cb4f5023e92e7634d3124 gencode/docs/events_validation.html +f282f7756318e544254c94055f68abfc7e78a0cf37e10bca4314d6e5e75b23a7 gencode/docs/metadata.html +123276c35494a06b615642da3de61aa9a54cf76d16da795e4b20dd711d57f837 gencode/docs/monitoring.html +474ca16edc9f3cad2bb3ab40b6993cbced90263f762f66ee6cd246a6c4a0d18f gencode/docs/persistent_device.html +e11595fd11477947a27461f8ef4fb6facb5f60e2abd6212193f7581ab123ff84 gencode/docs/properties.html +c006d0f46c8f007caa90ac76c713cead907669c14c09f4a288fac5b25afe05dd gencode/docs/query_cloud.html eeafb6e89a6c43816cfcb26244a95615a4ee75966e1c015cae5a13b6cfcb0078 gencode/docs/readme.md -741b880216be3743f6747800a042f2dbd89f3b0344c6b0a965f4bc010f03a930 gencode/docs/schema_doc.css -878ea88206c974f40643c3cc430875f9c4e8c5e3fd6bcd6358bd3eb6d48699a9 gencode/docs/schema_doc.min.js +2768fd01a875d1f58273e76fef9b421986824d2ab02251853840bca777b625c0 gencode/docs/schema_doc.css +165a29291d7d66653e46fd1ac5868f63e18f9d67c06ea9ebcb95d4830a528e68 gencode/docs/schema_doc.min.js 7ed934930aee763e0beebc349725ba3909115e8d346bb762f28bcbe745bb163a gencode/docs/schema_extras.js -9c87b8d3a99f572fae8bbe81868294c28d08f11f5eca276c0d113b98192c8338 gencode/docs/site_metadata.html -1bbcbf2d1ec1bf4554846b1daf09fa09c08dd967fa1f91ebec93027662529a31 gencode/docs/state.html -b2398e7f9e352c47867e38f97168f3eb88e23280c7dd576f13e038c8c3f714c9 gencode/docs/state_mapping.html -b8ff4cdb4b79449166b1c6e09ac0e58273ae62865b47bf943fdd365739c62a4c gencode/docs/state_validation.html +54fcbea8c75dda0f4c35397503bdc94afd0aa56ccc637b6d8e26344097c38dde gencode/docs/site_metadata.html +741de67fe3d920ba3ff8b3cd38f6b5d50f87e2b2045690493a3cac193e13562e gencode/docs/state.html +a47043c68388aa21f5c906e9aa773ed3defb9239771d604153d5d4006e0e4fb9 gencode/docs/state_mapping.html +0b18cfdc1e87e61e696f35d9edd11ffec19dac82260e6f33e8c154dc676f5cc8 gencode/docs/state_validation.html 0e0d87fa6bc2f746eaacfbcd0f1258c9c6beee2b03d995868af9aafcbc4a88dc gencode/java/udmi/schema/Area.java 768d8b010bc90c5fbe198daf58f3847247ecc620a6fc046fffba877399cf1888 gencode/java/udmi/schema/Asset.java e82d4e13a59ffbdfe412c46977b69e8dddb803a4cb7cbfe4ae84c91a3c5b108b gencode/java/udmi/schema/Auth_provider.java diff --git a/etc/requirements.txt b/etc/requirements.txt index b25d4495b5..b901f1501e 100644 --- a/etc/requirements.txt +++ b/etc/requirements.txt @@ -4,7 +4,7 @@ cachetools==5.0.0 certifi==2024.7.4 charset-normalizer==2.0.11 click==8.0.3 -dataclasses-json==0.5.6 +dataclasses-json==0.6.7 Deprecated==1.2.14 dill==0.3.6 exceptiongroup==1.2.2 @@ -26,11 +26,11 @@ importlib_metadata==8.4.0 iniconfig==2.0.0 isort==5.11.3 Jinja2==3.1.5 -json-schema-for-humans==0.40 +json-schema-for-humans==1.3.4 lazy-object-proxy==1.8.0 -markdown2==2.4.2 +markdown2==2.5.0 MarkupSafe==2.0.1 -marshmallow==3.14.1 +marshmallow==3.18.0 marshmallow-enum==1.5.1 mccabe==0.7.0 mypy-extensions==0.4.3 @@ -47,13 +47,13 @@ proto-plus==1.24.0 protobuf==5.26.1 pyasn1==0.4.8 pyasn1-modules==0.2.8 -Pygments==2.15.0 +Pygments==2.18.0 pylint==2.15.9 pyparsing==3.0.7 pytest==8.3.2 pytz==2021.3 -PyYAML==6.0.1 -requests==2.32.0 +PyYAML==6.0.2 +requests==2.32.3 requests-oauthlib==1.3.1 rsa==4.8 six==1.16.0 diff --git a/gencode/docs/commands_discovery.html b/gencode/docs/commands_discovery.html index b583a92c21..38142ce208 100644 --- a/gencode/docs/commands_discovery.html +++ b/gencode/docs/commands_discovery.html @@ -15,20 +15,20 @@ Discovery Command -

Discovery Command

+
-
Type: object
+

Discovery Command

Type: object

Discovery command for provisioning

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp discovery telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
diff --git a/gencode/docs/commands_mapping.html b/gencode/docs/commands_mapping.html index 181aa54eab..66bd215042 100644 --- a/gencode/docs/commands_mapping.html +++ b/gencode/docs/commands_mapping.html @@ -15,20 +15,20 @@ Mapping Command -

Mapping Command

+
-
Type: object
+

Mapping Command

Type: object

Mapping command for provisioning

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the configuration was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,12 +125,12 @@

guidType: string

device guid

 - + - - + + - + @@ -159,12 +159,12 @@

device_num_idType: number

numerical id assigned to this device

 - + - - + + - + @@ -190,16 +190,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -231,12 +231,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -276,12 +276,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -314,7 +314,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -539,12 +539,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -579,12 +579,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -619,12 +619,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -659,12 +659,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -699,12 +699,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -739,12 +739,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -779,12 +779,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -819,12 +819,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -859,12 +859,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -899,12 +899,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -939,12 +939,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -979,12 +979,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1019,12 +1019,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1059,12 +1059,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1099,12 +1099,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1139,12 +1139,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1179,12 +1179,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1219,12 +1219,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1259,12 +1259,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1299,12 +1299,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1339,12 +1339,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1379,12 +1379,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1419,12 +1419,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1459,12 +1459,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1499,12 +1499,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1539,12 +1539,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1579,12 +1579,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1619,12 +1619,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1659,12 +1659,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1699,12 +1699,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -1739,12 +1739,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -1779,12 +1779,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -1819,12 +1819,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -1859,12 +1859,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -1899,12 +1899,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -1939,12 +1939,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -1979,19 +1979,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2024,15 +2024,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2072,12 +2072,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2111,23 +2111,23 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - translation

Type: object
+ translation

Building Config

Type: object

Discovery result with implicit results

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="translation_pattern1" onclick="setAnchor('#translation_pattern1')">Building Translation Pattern Property

@@ -2137,7 +2137,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
@@ -2155,17 +2155,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - building_translation.json

Type: object
+ Building Translation

Building Translation

Type: object

Discovery result with implicit enumeration

 No Additional Properties - + - - + + - +
@@ -2204,12 +2204,12 @@

present_value

Type: string

dotted path to present_value field

 - + - - + + - +
@@ -2251,12 +2251,12 @@

unitsType: object
- + - - + + - + @@ -2298,12 +2298,12 @@

statesType: object
- + - - + + - + diff --git a/gencode/docs/config.html b/gencode/docs/config.html index cc9e7126b7..ef390ec2a3 100644 --- a/gencode/docs/config.html +++ b/gencode/docs/config.html @@ -15,20 +15,20 @@ Config -

Config

+
-
Type: object
+

Config

Type: object

The config block controls a device's intended behavior. Config Documentation

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the configuration was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,12 +125,12 @@

downgraded_fromType: string

Original version of schema pre-downgrade

 - + - - + + - + @@ -156,17 +156,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System Config

Type: object

System Config Documentation

 No Additional Properties - + - - + + - +
@@ -198,12 +198,12 @@

min_loglevel

Type: integer Default: 300

The minimum loglevel for reporting log messages below which log entries should not be sent. Default to 300.

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800

+ +

Value must be greater or equal to 100 and lesser or equal to 800

- +
@@ -239,12 +239,12 @@

metrics_rate_secType: integer Default: 10

The rate at which the system should send system event updates. 0 indicates no updates.

 - + - -

Value must be greater or equal to 0 and lesser or equal to 86400

+ +

Value must be greater or equal to 0 and lesser or equal to 86400

- + @@ -279,12 +279,12 @@

operationType: object
No Additional Properties - + - - + + - +
@@ -320,20 +320,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - mode

Type: enum (of string)
+ mode

System Mode

Type: enum (of string)

Operating mode for the device. Default is 'active'.
-

Must be one of:

-
  • "initial"
  • "active"
  • "updating"
  • "restart"
  • "terminate"
  • "shutdown"
-
- +

Must be one of:

+
  • "initial"
  • "active"
  • "updating"
  • "restart"
  • "terminate"
  • "shutdown"
+
+ - - + + - + @@ -373,15 +373,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_startType: string
+ last_startType: stringFormat: date-time

Last time a device with this id said it restarted: being later than status-supplied last_start indicates resource conflict.

 - + - - + + - + @@ -418,17 +418,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - testingType: object
+ testing

Testing System Config

Type: object

Configuration parameters for device-under-test

 No Additional Properties - + - - + + - +
@@ -467,12 +467,12 @@

sequence_name

Type: string

The sequence name currently being tested (for debug logging)

 - + - - + + - +
@@ -515,12 +515,12 @@

transaction_idType: string

The transaction id used to generate this config update

 - + - - + + - + @@ -563,12 +563,12 @@

config_baseType: integer

The configuration version that this update was based on

 - + - - + + - + @@ -611,12 +611,12 @@

endpoint_typeType: string

Designator for the kind of endpoint being used for this test

 - + - - + + - + @@ -650,17 +650,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Config

Type: object

Configuration for gateways. Only required for devices which are acting as gateways

 No Additional Properties - + - - + + - +
@@ -692,12 +692,12 @@

proxy_ids

Type: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -725,12 +725,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -771,17 +771,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

For proxied devices, this represents the target proxy device address for use by its gateway

 No Additional Properties - + - - + + - +
@@ -820,12 +820,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -871,12 +871,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -892,7 +892,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -926,12 +926,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -978,12 +978,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -1026,12 +1026,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -1073,12 +1073,12 @@

familyType: string
- + - - + + - + @@ -1112,17 +1112,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discoveryType: object
+ discovery

Discovery Config

Type: object

Configuration for discovery

 No Additional Properties - + - - + + - +
@@ -1151,15 +1151,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generation
Type: stringFormat: date-time

Generational marker for controlling enumeration

 - + - - + + - +
@@ -1195,12 +1195,12 @@

enumerationsType: object

Enumeration depth for self-enumerations.

 No Additional Properties - + - - + + - +
@@ -1240,15 +1240,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+
  • "buckets"
  • "entries"
  • "details"
  • "parts"
+
+ - - + + - +
@@ -1292,15 +1292,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+ + + - - + + - + @@ -1344,15 +1344,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+ + + - - + + - + @@ -1396,15 +1396,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+ + + - - + + - + @@ -1444,18 +1444,18 @@

familiesType: object

Address family configs for discovery scans.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_families_pattern1" onclick="setAnchor('#discovery_families_pattern1')">Family Discovery Config Pattern Property

@@ -1465,7 +1465,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -1490,17 +1490,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - config_discovery_family.json

Type: object
+ Family Discovery Config

Family Discovery Config

Type: object

Configuration for discovery

 No Additional Properties - + - - + + - +
@@ -1543,15 +1543,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generation
Type: stringFormat: date-time

Generational marker for controlling discovery

 - + - - + + - +
@@ -1601,12 +1601,12 @@

scan_interval_secType: integer

Period, in seconds, for automatic scanning

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -1656,12 +1656,12 @@

scan_duration_secType: integer

Scan duration, in seconds

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -1711,12 +1711,12 @@

passive_secType: integer

Holdoff time for passively discovered devices

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -1768,15 +1768,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+ + + - - + + - + @@ -1814,17 +1814,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - localnetType: object
+ localnet

Localnet Config

Type: object

Currently unused: request local network configuration

 No Additional Properties - + - - + + - +
@@ -1856,18 +1856,18 @@

families

Type: object

Address family config for reporting.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="localnet_families_pattern1" onclick="setAnchor('#localnet_families_pattern1')">Family Localnet Config Pattern Property

@@ -1877,7 +1877,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -1902,16 +1902,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - config_localnet_family.json

Type: object
+ Family Localnet Config

Family Localnet Config

Type: object
- + - - + + - +
@@ -1945,16 +1945,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - blobsetType: object
+ blobset

Blobset Config

Type: object
No Additional Properties - + - - + + - +
@@ -1983,20 +1983,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - blobsets

Type: enum (of string)
+ blobsets

System Blobsets

Type: enum (of string)

Placeholder to create generated code enum
-

Must be one of:

-
  • "_iot_endpoint_config"
-
- +

Must be one of:

+ +
+ - - + + - + @@ -2031,18 +2031,18 @@

blobsType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="blobset_blobs_pattern1" onclick="setAnchor('#blobset_blobs_pattern1')">Blob Blobset Config Pattern Property

@@ -2052,7 +2052,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^_?[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -2077,16 +2077,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - config_blobset_blob.json#

Type: object
+ Blob Blobset Config

Blob Blobset Config

Type: object
No Additional Properties - + - - + + - +
@@ -2129,20 +2129,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - phase

Type: enum (of string)
+ phase

BlobPhase

Type: enum (of string)

Phase for the management of a configuration blob.
-

Must be one of:

-
  • "apply"
  • "final"
-
- +

Must be one of:

+
  • "apply"
  • "final"
+
+ - - + + - +
@@ -2191,12 +2191,12 @@

urlType: string
- + - - + + - + @@ -2246,12 +2246,12 @@

sha256Type: string

Expected hash of the retrieved resource

Must match regular expression: ^[0-9a-f]{64}$ - + - - + + - + @@ -2298,15 +2298,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

RFC 3339 UTC timestamp of the blob generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -2348,17 +2348,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - pointset

Type: object
+ pointset

Pointset Config

Type: object

Pointset Config Documentation

 No Additional Properties - + - - + + - +
@@ -2387,15 +2387,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the configuration was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -2435,12 +2435,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -2476,12 +2476,12 @@

state_etagType: string

The state_etag of the last state message sent by the device. Writeback documentation

 - + - -

Must be at most 32 characters long

+ +

Must be at most 32 characters long

- + @@ -2514,15 +2514,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - set_value_expiryType: string
+ set_value_expiryType: stringFormat: date-time

An expiry for the the device to revert to baseline (no set value). Writeback documentation

 - + - - + + - + @@ -2558,12 +2558,12 @@

sample_limit_secType: integer

Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.

 - + - -

Value must be greater or equal to 0 and lesser or equal to 86400

+ +

Value must be greater or equal to 0 and lesser or equal to 86400

- + @@ -2599,12 +2599,12 @@

sample_rate_secType: integer

Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 600.

 - + - -

Value must be greater or equal to 1 and lesser or equal to 86400

+ +

Value must be greater or equal to 1 and lesser or equal to 86400

- + @@ -2640,18 +2640,18 @@

pointsType: object

The points defined in this dictionary is the authoritative source indicating the representative points for the device (in both telemetry and state messages). Pointset doumentation

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1" onclick="setAnchor('#pointset_points_pattern1')">Point Pointset Config Pattern Property

@@ -2661,7 +2661,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -2686,16 +2686,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - config_pointset_point.json#

Type: object
+ Point Pointset Config

Point Pointset Config

Type: object
No Additional Properties - + - - + + - +
@@ -2741,12 +2741,12 @@

ref

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)

 - + - - + + -
+
Example:

"AI1106"
@@ -2800,12 +2800,12 @@

units

Type: string

If specified, indicates the units the device should report the data in.

 - + - - + + - +
@@ -2855,12 +2855,12 @@

set_valueType: object

Used for cloud writeback functionality, this field specifies the value for a given point in the device's current units.

 - + - - + + -
+
Example:

22.4
@@ -2911,15 +2911,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stop_time

Type: string
+ stop_timeType: stringFormat: date-time

RFC 3339 timestamp for the specified point write easing to stop

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -2973,12 +2973,12 @@

cov_increment

Type: number

The CoV (change of value) increment, which when set, enables CoV on the point and defines the minimum change in present value of the respective point before an update is published

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + diff --git a/gencode/docs/config_mapping.html b/gencode/docs/config_mapping.html index 6725b90538..8a3807df75 100644 --- a/gencode/docs/config_mapping.html +++ b/gencode/docs/config_mapping.html @@ -15,20 +15,20 @@ Mapping Config -

Mapping Config

+
-
Type: object
+

Mapping Config

Type: object

Configuration for mapping

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 timestamp the configuration was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,18 +125,18 @@

devicesType: object

Configuration of mapped devices

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="devices_pattern1" onclick="setAnchor('#devices_pattern1')">Device Mapping Config Pattern Property

@@ -146,7 +146,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
@@ -164,17 +164,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - config_mapping_device.json

Type: object
+ Device Mapping Config

Device Mapping Config

Type: object

Configuration for mapping

 No Additional Properties - + - - + + - +
@@ -213,12 +213,12 @@

guid

Type: string

Device guid

 - + - - + + - +
@@ -258,15 +258,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - appliedType: string
+ appliedType: stringFormat: date-time

Last time the mapping was successfully applied for this device

 - + - - + + - + @@ -306,15 +306,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - requestedType: string
+ requestedType: stringFormat: date-time

Timestamp of requested device model export

 - + - - + + - + @@ -354,16 +354,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -409,12 +409,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -468,12 +468,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -520,7 +520,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -759,12 +759,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -813,12 +813,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -867,12 +867,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -921,12 +921,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -975,12 +975,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -1029,12 +1029,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1083,12 +1083,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1137,12 +1137,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1191,12 +1191,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1245,12 +1245,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1299,12 +1299,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1353,12 +1353,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1407,12 +1407,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1461,12 +1461,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1515,12 +1515,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1569,12 +1569,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1623,12 +1623,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1677,12 +1677,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1731,12 +1731,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1785,12 +1785,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1839,12 +1839,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1893,12 +1893,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1947,12 +1947,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -2001,12 +2001,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -2055,12 +2055,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2109,12 +2109,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2163,12 +2163,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2217,12 +2217,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2271,12 +2271,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2325,12 +2325,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2379,12 +2379,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2433,12 +2433,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2487,12 +2487,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2541,12 +2541,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2595,12 +2595,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2649,12 +2649,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2703,19 +2703,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2762,15 +2762,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2824,12 +2824,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
diff --git a/gencode/docs/configuration_endpoint.html b/gencode/docs/configuration_endpoint.html index d3267a0fea..50f5297af3 100644 --- a/gencode/docs/configuration_endpoint.html +++ b/gencode/docs/configuration_endpoint.html @@ -15,20 +15,20 @@ Endpoint Configuration -

Endpoint Configuration

+
-
Type: object
+

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -53,12 +53,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -86,15 +86,15 @@

protocol

Type: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -122,15 +122,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -158,12 +158,12 @@

hostnameType: string
- + - - + + - + @@ -192,12 +192,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -226,12 +226,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -259,12 +259,12 @@

portType: integer
- + - - + + - + @@ -293,12 +293,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -326,12 +326,12 @@

client_idType: string
- + - - + + - + @@ -360,12 +360,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -394,12 +394,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -428,12 +428,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -462,12 +462,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -495,12 +495,12 @@

gatewayIdType: string
- + - - + + - + @@ -528,12 +528,12 @@

deviceIdType: string
- + - - + + - + @@ -562,12 +562,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -596,12 +596,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -630,12 +630,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -664,12 +664,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -698,12 +698,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -731,12 +731,12 @@

keyBytesType: object
- + - - + + - + @@ -764,12 +764,12 @@

algorithmType: string
- + - - + + - + @@ -797,12 +797,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -833,12 +833,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -876,12 +876,12 @@

username

Type: string
- + - - + + - +
@@ -923,12 +923,12 @@

password

Type: string
- + - - + + - + @@ -967,12 +967,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -1010,12 +1010,12 @@

audience

Type: string
- + - - + + - +
@@ -1049,15 +1049,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
diff --git a/gencode/docs/configuration_execution.html b/gencode/docs/configuration_execution.html index 88d54bf160..279f05edc6 100644 --- a/gencode/docs/configuration_execution.html +++ b/gencode/docs/configuration_execution.html @@ -15,20 +15,20 @@ Execution Configuration -

Execution Configuration

+
-
Type: object
+

Execution Configuration

Type: object

Parameters for configuring the execution run of a UDMI tool

 No Additional Properties - + - - + + - +
@@ -52,12 +52,12 @@

registry_id

Type: string
- + - - + + - +
@@ -85,12 +85,12 @@

cloud_region

Type: string
- + - - + + - + @@ -118,12 +118,12 @@

site_nameType: string
- + - - + + - + @@ -151,12 +151,12 @@

update_topicType: string
- + - - + + - + @@ -184,12 +184,12 @@

feed_nameType: string
- + - - + + - + @@ -217,12 +217,12 @@

reflect_regionType: string
- + - - + + - + @@ -250,12 +250,12 @@

site_modelType: string
- + - - + + - + @@ -283,12 +283,12 @@

src_fileType: string
- + - - + + - + @@ -316,12 +316,12 @@

registry_suffixType: string
- + - - + + - + @@ -349,12 +349,12 @@

shard_countType: integer
- + - - + + - + @@ -382,12 +382,12 @@

shard_indexType: integer
- + - - + + - + @@ -415,12 +415,12 @@

device_idType: string
- + - - + + - + @@ -446,19 +446,19 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - iot_providerType: enum (of string)
+ iot_provider

Iot Provider

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -484,17 +484,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - reflector_endpointType: object
+ reflector_endpoint

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -526,12 +526,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -566,15 +566,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -609,15 +609,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -652,12 +652,12 @@

hostnameType: string
- + - - + + - + @@ -693,12 +693,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -734,12 +734,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -774,12 +774,12 @@

portType: integer
- + - - + + - + @@ -815,12 +815,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -855,12 +855,12 @@

client_idType: string
- + - - + + - + @@ -896,12 +896,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -937,12 +937,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -978,12 +978,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -1019,12 +1019,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -1059,12 +1059,12 @@

gatewayIdType: string
- + - - + + - + @@ -1099,12 +1099,12 @@

deviceIdType: string
- + - - + + - + @@ -1140,12 +1140,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -1181,12 +1181,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -1222,12 +1222,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -1263,12 +1263,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -1304,12 +1304,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -1344,12 +1344,12 @@

keyBytesType: object
- + - - + + - + @@ -1384,12 +1384,12 @@

algorithmType: string
- + - - + + - + @@ -1424,12 +1424,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -1467,12 +1467,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -1517,12 +1517,12 @@

username

Type: string
- + - - + + - +
@@ -1571,12 +1571,12 @@

password

Type: string
- + - - + + - + @@ -1622,12 +1622,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -1672,12 +1672,12 @@

audience

Type: string
- + - - + + - +
@@ -1718,15 +1718,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -1760,17 +1760,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - device_endpoint

Type: object
+ device_endpoint

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -1802,12 +1802,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -1842,15 +1842,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -1885,15 +1885,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -1928,12 +1928,12 @@

hostnameType: string
- + - - + + - + @@ -1969,12 +1969,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -2010,12 +2010,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -2050,12 +2050,12 @@

portType: integer
- + - - + + - + @@ -2091,12 +2091,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -2131,12 +2131,12 @@

client_idType: string
- + - - + + - + @@ -2172,12 +2172,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -2213,12 +2213,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2254,12 +2254,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2295,12 +2295,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2335,12 +2335,12 @@

gatewayIdType: string
- + - - + + - + @@ -2375,12 +2375,12 @@

deviceIdType: string
- + - - + + - + @@ -2416,12 +2416,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -2457,12 +2457,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -2498,12 +2498,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -2539,12 +2539,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -2580,12 +2580,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -2620,12 +2620,12 @@

keyBytesType: object
- + - - + + - + @@ -2660,12 +2660,12 @@

algorithmType: string
- + - - + + - + @@ -2700,12 +2700,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -2743,12 +2743,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -2793,12 +2793,12 @@

username

Type: string
- + - - + + - +
@@ -2847,12 +2847,12 @@

password

Type: string
- + - - + + - + @@ -2898,12 +2898,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -2948,12 +2948,12 @@

audience

Type: string
- + - - + + - +
@@ -2994,15 +2994,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -3038,12 +3038,12 @@

project_id

Type: string
- + - - + + - + @@ -3071,12 +3071,12 @@

user_nameType: string
- + - - + + - + @@ -3104,12 +3104,12 @@

udmi_namespaceType: string
- + - - + + - + @@ -3137,12 +3137,12 @@

bridge_hostType: string
- + - - + + - + @@ -3170,12 +3170,12 @@

key_fileType: string
- + - - + + - + @@ -3203,12 +3203,12 @@

serial_noType: string
- + - - + + - + @@ -3236,12 +3236,12 @@

log_levelType: string
- + - - + + - + @@ -3269,12 +3269,12 @@

min_stageType: string
- + - - + + - + @@ -3303,12 +3303,12 @@

udmi_versionType: string

Semantic tagged version of udmis install

 - + - - + + - + @@ -3337,12 +3337,12 @@

udmi_commitType: string

Commit hash of this udmis install

 - + - - + + - + @@ -3371,12 +3371,12 @@

udmi_refType: string

Complete reference of udmis install

 - + - - + + - + @@ -3405,12 +3405,12 @@

udmi_timeverType: string

Timestamp version id of udmis install

 - + - - + + - + @@ -3438,12 +3438,12 @@

enforce_versionType: boolean
- + - - + + - + @@ -3471,12 +3471,12 @@

udmi_rootType: string
- + - - + + - + @@ -3505,12 +3505,12 @@

update_toType: string

Optional version for a udmis update trigger

 - + - - + + - + @@ -3538,12 +3538,12 @@

alt_projectType: string
- + - - + + - + @@ -3571,12 +3571,12 @@

alt_registryType: string
- + - - + + - + @@ -3604,12 +3604,12 @@

block_unknownType: boolean
- + - - + + - + @@ -3637,12 +3637,12 @@

sequencesType: array of string
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -3663,12 +3663,12 @@

Each item of this array must be:

sequences items
Type: string
- + - - + + - +
diff --git a/gencode/docs/configuration_pod.html b/gencode/docs/configuration_pod.html index 5f3d90821f..a3e166c376 100644 --- a/gencode/docs/configuration_pod.html +++ b/gencode/docs/configuration_pod.html @@ -15,20 +15,20 @@ Pod Configuration -

Pod Configuration

+
-
Type: object
+

Pod Configuration

Type: object

Parameters for configuring the execution run of a UDMIS pod

 No Additional Properties - + - - + + - +
@@ -52,12 +52,12 @@

include

Type: string
- + - - + + - +
@@ -83,17 +83,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - baseType: object
+ base

Base Pod Configuration

Type: object

Parameters to define pod base parameters

 No Additional Properties - + - - + + - +
@@ -125,12 +125,12 @@

udmi_prefix

Type: string

prefix for udmi namespacing

 - + - - + + - +
@@ -166,12 +166,12 @@

failure_rateType: number

chance of random failure in various bits of the system

 - + - - + + - + @@ -201,17 +201,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - flow_defaultsType: object
+ flow_defaults

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -243,12 +243,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -283,15 +283,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -326,15 +326,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -369,12 +369,12 @@

hostnameType: string
- + - - + + - + @@ -410,12 +410,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -451,12 +451,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -491,12 +491,12 @@

portType: integer
- + - - + + - + @@ -532,12 +532,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -572,12 +572,12 @@

client_idType: string
- + - - + + - + @@ -613,12 +613,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -654,12 +654,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -695,12 +695,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -736,12 +736,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -776,12 +776,12 @@

gatewayIdType: string
- + - - + + - + @@ -816,12 +816,12 @@

deviceIdType: string
- + - - + + - + @@ -857,12 +857,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -898,12 +898,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -939,12 +939,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -980,12 +980,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -1021,12 +1021,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -1061,12 +1061,12 @@

keyBytesType: object
- + - - + + - + @@ -1101,12 +1101,12 @@

algorithmType: string
- + - - + + - + @@ -1141,12 +1141,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -1184,12 +1184,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -1234,12 +1234,12 @@

username

Type: string
- + - - + + - +
@@ -1288,12 +1288,12 @@

password

Type: string
- + - - + + - + @@ -1339,12 +1339,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -1389,12 +1389,12 @@

audience

Type: string
- + - - + + - +
@@ -1435,15 +1435,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -1479,18 +1479,18 @@

crons

Type: object
- + - - + + - +

+ aria-expanded="" aria-controls="crons_pattern1" onclick="setAnchor('#crons_pattern1')">Endpoint Configuration Pattern Property

@@ -1500,7 +1500,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -1518,17 +1518,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configuration_endpoint.json

Type: object
+ Endpoint Configuration

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -1567,12 +1567,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -1614,15 +1614,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -1664,15 +1664,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -1714,12 +1714,12 @@

hostnameType: string
- + - - + + - + @@ -1762,12 +1762,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -1810,12 +1810,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -1857,12 +1857,12 @@

portType: integer
- + - - + + - + @@ -1905,12 +1905,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -1952,12 +1952,12 @@

client_idType: string
- + - - + + - + @@ -2000,12 +2000,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -2048,12 +2048,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2096,12 +2096,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2144,12 +2144,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -2191,12 +2191,12 @@

gatewayIdType: string
- + - - + + - + @@ -2238,12 +2238,12 @@

deviceIdType: string
- + - - + + - + @@ -2286,12 +2286,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -2334,12 +2334,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -2382,12 +2382,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -2430,12 +2430,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -2478,12 +2478,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -2525,12 +2525,12 @@

keyBytesType: object
- + - - + + - + @@ -2572,12 +2572,12 @@

algorithmType: string
- + - - + + - + @@ -2619,12 +2619,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -2669,12 +2669,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -2726,12 +2726,12 @@

username

Type: string
- + - - + + - +
@@ -2787,12 +2787,12 @@

password

Type: string
- + - - + + - + @@ -2845,12 +2845,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -2902,12 +2902,12 @@

audience

Type: string
- + - - + + - +
@@ -2955,15 +2955,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -3003,18 +3003,18 @@

flows

Type: object
- + - - + + - +

+ aria-expanded="" aria-controls="flows_pattern1" onclick="setAnchor('#flows_pattern1')">Endpoint Configuration Pattern Property

@@ -3024,7 +3024,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -3042,17 +3042,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configuration_endpoint.json

Type: object
+ Endpoint Configuration

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -3091,12 +3091,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -3138,15 +3138,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -3188,15 +3188,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -3238,12 +3238,12 @@

hostnameType: string
- + - - + + - + @@ -3286,12 +3286,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -3334,12 +3334,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -3381,12 +3381,12 @@

portType: integer
- + - - + + - + @@ -3429,12 +3429,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -3476,12 +3476,12 @@

client_idType: string
- + - - + + - + @@ -3524,12 +3524,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -3572,12 +3572,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -3620,12 +3620,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -3668,12 +3668,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -3715,12 +3715,12 @@

gatewayIdType: string
- + - - + + - + @@ -3762,12 +3762,12 @@

deviceIdType: string
- + - - + + - + @@ -3810,12 +3810,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -3858,12 +3858,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -3906,12 +3906,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -3954,12 +3954,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -4002,12 +4002,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -4049,12 +4049,12 @@

keyBytesType: object
- + - - + + - + @@ -4096,12 +4096,12 @@

algorithmType: string
- + - - + + - + @@ -4143,12 +4143,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -4193,12 +4193,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -4250,12 +4250,12 @@

username

Type: string
- + - - + + - +
@@ -4311,12 +4311,12 @@

password

Type: string
- + - - + + - + @@ -4369,12 +4369,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -4426,12 +4426,12 @@

audience

Type: string
- + - - + + - +
@@ -4479,15 +4479,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -4527,18 +4527,18 @@

bridges

Type: object
- + - - + + - +

+ aria-expanded="" aria-controls="bridges_pattern1" onclick="setAnchor('#bridges_pattern1')">Bridge Pod Configuration Pattern Property

@@ -4548,7 +4548,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -4566,17 +4566,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configuration_pod_bridge.json

Type: object
+ Bridge Pod Configuration

Bridge Pod Configuration

Type: object

Parameters to define a bridge between message domains

 No Additional Properties - + - - + + - +
@@ -4614,12 +4614,12 @@

enabled

Type: string
- + - - + + - +
@@ -4659,17 +4659,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - fromType: object
+ from

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -4715,12 +4715,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -4769,15 +4769,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -4826,15 +4826,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -4883,12 +4883,12 @@

hostnameType: string
- + - - + + - + @@ -4938,12 +4938,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -4993,12 +4993,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -5047,12 +5047,12 @@

portType: integer
- + - - + + - + @@ -5102,12 +5102,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -5156,12 +5156,12 @@

client_idType: string
- + - - + + - + @@ -5211,12 +5211,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -5266,12 +5266,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -5321,12 +5321,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -5376,12 +5376,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -5430,12 +5430,12 @@

gatewayIdType: string
- + - - + + - + @@ -5484,12 +5484,12 @@

deviceIdType: string
- + - - + + - + @@ -5539,12 +5539,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -5594,12 +5594,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -5649,12 +5649,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -5704,12 +5704,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -5759,12 +5759,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -5813,12 +5813,12 @@

keyBytesType: object
- + - - + + - + @@ -5867,12 +5867,12 @@

algorithmType: string
- + - - + + - + @@ -5921,12 +5921,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -5978,12 +5978,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -6042,12 +6042,12 @@

username

Type: string
- + - - + + - +
@@ -6110,12 +6110,12 @@

password

Type: string
- + - - + + - + @@ -6175,12 +6175,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -6239,12 +6239,12 @@

audience

Type: string
- + - - + + - +
@@ -6299,15 +6299,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -6355,17 +6355,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - morf

Type: object
+ morf

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -6411,12 +6411,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -6465,15 +6465,15 @@

protocolType: enum (of string)
-

Must be one of:

-
  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"
-
- +

Must be one of:

+ + + - - + + - + @@ -6522,15 +6522,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -6579,12 +6579,12 @@

hostnameType: string
- + - - + + - + @@ -6634,12 +6634,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -6689,12 +6689,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -6743,12 +6743,12 @@

portType: integer
- + - - + + - + @@ -6798,12 +6798,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -6852,12 +6852,12 @@

client_idType: string
- + - - + + - + @@ -6907,12 +6907,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -6962,12 +6962,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -7017,12 +7017,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -7072,12 +7072,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -7126,12 +7126,12 @@

gatewayIdType: string
- + - - + + - + @@ -7180,12 +7180,12 @@

deviceIdType: string
- + - - + + - + @@ -7235,12 +7235,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -7290,12 +7290,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -7345,12 +7345,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -7400,12 +7400,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -7455,12 +7455,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -7509,12 +7509,12 @@

keyBytesType: object
- + - - + + - + @@ -7563,12 +7563,12 @@

algorithmType: string
- + - - + + - + @@ -7617,12 +7617,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -7674,12 +7674,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -7738,12 +7738,12 @@

username

Type: string
- + - - + + - +
@@ -7806,12 +7806,12 @@

password

Type: string
- + - - + + - + @@ -7871,12 +7871,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -7935,12 +7935,12 @@

audience

Type: string
- + - - + + - +
@@ -7995,15 +7995,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -8045,20 +8045,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - iot_access

Type: object
+ iot_access

Iot Access Providers

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="iot_access_pattern1" onclick="setAnchor('#iot_access_pattern1')">Iot Access Pattern Property

@@ -8068,7 +8068,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]+$
@@ -8086,16 +8086,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - access_iot.json

Type: object
+ Iot Access

Iot Access

Type: object
No Additional Properties - + - - + + - +
@@ -8133,12 +8133,12 @@

name

Type: string
- + - - + + - +
@@ -8178,19 +8178,19 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - providerType: enum (of string)
+ provider

Iot Provider

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -8232,12 +8232,12 @@

project_idType: string
- + - - + + - + @@ -8279,12 +8279,12 @@

profile_secType: integer
- + - - + + - + @@ -8326,12 +8326,12 @@

optionsType: string
- + - - + + - + @@ -8365,20 +8365,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - iot_dataType: object
+ iot_data

Iot Data Provider

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="iot_data_pattern1" onclick="setAnchor('#iot_data_pattern1')">Iot Access Pattern Property

@@ -8388,7 +8388,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]+$
@@ -8406,16 +8406,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - access_iot.json

Type: object
+ Iot Access

Iot Access

Type: object
No Additional Properties - + - - + + - +
@@ -8453,12 +8453,12 @@

name

Type: string
- + - - + + - +
@@ -8498,19 +8498,19 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - providerType: enum (of string)
+ provider

Iot Provider

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -8552,12 +8552,12 @@

project_idType: string
- + - - + + - + @@ -8599,12 +8599,12 @@

profile_secType: integer
- + - - + + - + @@ -8646,12 +8646,12 @@

optionsType: string
- + - - + + - + diff --git a/gencode/docs/configuration_pubber.html b/gencode/docs/configuration_pubber.html index 658fad1da8..ef85b4fd6b 100644 --- a/gencode/docs/configuration_pubber.html +++ b/gencode/docs/configuration_pubber.html @@ -15,20 +15,20 @@ Pubber Configuration -

Pubber Configuration

+
-
Type: object
+

Pubber Configuration

Type: object

Parameters to define a pubber runtime instance

 - + - - + + - +
@@ -50,17 +50,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - endpoint

Type: object
+ endpoint

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -92,12 +92,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -132,15 +132,15 @@

protocol

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -175,15 +175,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -218,12 +218,12 @@

hostnameType: string
- + - - + + - + @@ -259,12 +259,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -300,12 +300,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -340,12 +340,12 @@

portType: integer
- + - - + + - + @@ -381,12 +381,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -421,12 +421,12 @@

client_idType: string
- + - - + + - + @@ -462,12 +462,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -503,12 +503,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -544,12 +544,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -585,12 +585,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -625,12 +625,12 @@

gatewayIdType: string
- + - - + + - + @@ -665,12 +665,12 @@

deviceIdType: string
- + - - + + - + @@ -706,12 +706,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -747,12 +747,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -788,12 +788,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -829,12 +829,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -870,12 +870,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -910,12 +910,12 @@

keyBytesType: object
- + - - + + - + @@ -950,12 +950,12 @@

algorithmType: string
- + - - + + - + @@ -990,12 +990,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -1033,12 +1033,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -1083,12 +1083,12 @@

username

Type: string
- + - - + + - +
@@ -1137,12 +1137,12 @@

password

Type: string
- + - - + + - + @@ -1188,12 +1188,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -1238,12 +1238,12 @@

audience

Type: string
- + - - + + - +
@@ -1284,15 +1284,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -1329,12 +1329,12 @@

iotProject

Type: string

IoT Core ingest project id

 - + - - + + - + @@ -1362,12 +1362,12 @@

projectIdType: string
- + - - + + - + @@ -1395,12 +1395,12 @@

registryIdType: string
- + - - + + - + @@ -1428,12 +1428,12 @@

deviceIdType: string
- + - - + + - + @@ -1461,12 +1461,12 @@

gatewayIdType: string
- + - - + + - + @@ -1494,12 +1494,12 @@

sitePathType: string
- + - - + + - + @@ -1527,12 +1527,12 @@

keyFileType: string Default: "local/rsa_private.pkcs8"
- + - - + + - + @@ -1560,12 +1560,12 @@

algorithmType: string Default: "RS256"
- + - - + + - + @@ -1593,12 +1593,12 @@

serialNoType: string
- + - - + + - + @@ -1626,12 +1626,12 @@

macAddrType: string
- + - - + + - + @@ -1659,12 +1659,12 @@

keyBytesType: object
- + - - + + - + @@ -1690,17 +1690,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - optionsType: object
+ options

Pubber Options

Type: object

Pubber runtime options

 - + - - + + - +
@@ -1731,12 +1731,12 @@

fixedSampleRate

Type: integer
- + - - + + - +
@@ -1771,12 +1771,12 @@

noHardwareType: boolean
- + - - + + - + @@ -1811,12 +1811,12 @@

noConfigAckType: boolean
- + - - + + - + @@ -1851,12 +1851,12 @@

noPersistType: boolean
- + - - + + - + @@ -1891,12 +1891,12 @@

noLastStartType: boolean
- + - - + + - + @@ -1931,12 +1931,12 @@

noLastConfigType: boolean
- + - - + + - + @@ -1971,12 +1971,12 @@

badCategoryType: boolean
- + - - + + - + @@ -2011,12 +2011,12 @@

badVersionType: boolean
- + - - + + - + @@ -2051,12 +2051,12 @@

badAddrType: boolean
- + - - + + - + @@ -2091,12 +2091,12 @@

noProxyType: boolean
- + - - + + - + @@ -2131,12 +2131,12 @@

extraDeviceType: boolean
- + - - + + - + @@ -2171,12 +2171,12 @@

barfConfigType: boolean
- + - - + + - + @@ -2211,12 +2211,12 @@

messageTraceType: boolean
- + - - + + - + @@ -2251,12 +2251,12 @@

extraPointType: string
- + - - + + - + @@ -2291,12 +2291,12 @@

configStateDelayType: boolean
- + - - + + - + @@ -2331,12 +2331,12 @@

missingPointType: string
- + - - + + - + @@ -2371,12 +2371,12 @@

extraFieldType: string
- + - - + + - + @@ -2411,12 +2411,12 @@

emptyMissingType: boolean
- + - - + + - + @@ -2451,12 +2451,12 @@

redirectRegistryType: string
- + - - + + - + @@ -2491,12 +2491,12 @@

smokeCheckType: boolean
- + - - + + - + @@ -2531,12 +2531,12 @@

skewClockType: boolean
- + - - + + - + @@ -2571,12 +2571,12 @@

noPointStateType: boolean
- + - - + + - + @@ -2611,12 +2611,12 @@

noStateType: boolean
- + - - + + - + @@ -2651,12 +2651,12 @@

noStatusType: boolean
- + - - + + - + @@ -2691,12 +2691,12 @@

noFolderType: boolean
- + - - + + - + @@ -2731,12 +2731,12 @@

badLevelType: boolean
- + - - + + - + @@ -2771,12 +2771,12 @@

spamStateType: boolean
- + - - + + - + @@ -2811,12 +2811,12 @@

tweakStateType: boolean
- + - - + + - + @@ -2851,12 +2851,12 @@

badStateType: boolean
- + - - + + - + @@ -2891,12 +2891,12 @@

baseStateType: boolean
- + - - + + - + @@ -2931,12 +2931,12 @@

dupeStateType: boolean
- + - - + + - + @@ -2971,12 +2971,12 @@

noLogType: boolean
- + - - + + - + @@ -3011,12 +3011,12 @@

featureEnableSwapType: boolean
- + - - + + - + @@ -3052,12 +3052,12 @@

disableWritebackType: boolean

Disable writeback, equivelant to marking all points as unwriteable

 - + - - + + - + @@ -3093,12 +3093,12 @@

noWritebackType: boolean

Removes writeback functionality, mimicking a device without Writeback support

 - + - - + + - + @@ -3133,12 +3133,12 @@

fixedLogLevelType: integer
- + - - + + - + @@ -3173,12 +3173,12 @@

softwareFirmwareValueType: string
- + - - + + - + @@ -3213,12 +3213,12 @@

additionalPropertiesType: object
- + - - + + - + @@ -3250,12 +3250,12 @@

additionalPropertiesType: object
- + - - + + - + diff --git a/gencode/docs/data_template.html b/gencode/docs/data_template.html index 80ebb03f9f..85051dec89 100644 --- a/gencode/docs/data_template.html +++ b/gencode/docs/data_template.html @@ -15,20 +15,20 @@ Message Template Data -

Message Template Data

+
-
Type: object
+

Message Template Data

Type: object

Information container for simple template substitution.

 No Additional Properties - + - - + + - +
@@ -53,12 +53,12 @@

timestamp

Type: string

Message timestamp

 - + - - + + - +
diff --git a/gencode/docs/events.html b/gencode/docs/events.html index cf2458d8e3..613b4f6cba 100644 --- a/gencode/docs/events.html +++ b/gencode/docs/events.html @@ -15,20 +15,20 @@ Events -

Events

+
-
Type: object
+

Events

Type: object

Container object for all event schemas, not directly used.

 No Additional Properties - + - - + + - +
@@ -50,17 +50,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - system

Type: object
+ system

System Events

Type: object

Used for system events such as logging. System Event Documentation

 No Additional Properties - + - - + + - +
@@ -89,15 +89,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the event payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -137,12 +137,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -178,12 +178,12 @@

upgraded_fromType: string

Original version of schema pre-upgrade

 - + - - + + - + @@ -216,15 +216,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_configType: string
+ last_configType: stringFormat: date-time

Last config received

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -263,12 +263,12 @@

logentries

Type: array
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -294,16 +294,16 @@

Each item of this array must be:

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entry.json
Type: object
+ Entry

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -349,12 +349,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -408,12 +408,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -460,7 +460,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -699,12 +699,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -753,12 +753,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -807,12 +807,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -861,12 +861,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -915,12 +915,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -969,12 +969,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1023,12 +1023,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1077,12 +1077,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1131,12 +1131,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1185,12 +1185,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1239,12 +1239,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1293,12 +1293,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1347,12 +1347,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1401,12 +1401,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1455,12 +1455,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1509,12 +1509,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1563,12 +1563,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1617,12 +1617,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1671,12 +1671,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1725,12 +1725,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1779,12 +1779,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1833,12 +1833,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1887,12 +1887,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1941,12 +1941,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1995,12 +1995,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2049,12 +2049,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2103,12 +2103,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2157,12 +2157,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2211,12 +2211,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2265,12 +2265,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2319,12 +2319,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2373,12 +2373,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2427,12 +2427,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2481,12 +2481,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2535,12 +2535,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2589,12 +2589,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2643,19 +2643,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2702,15 +2702,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2764,12 +2764,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2815,12 +2815,12 @@

event_no

Type: integer

Sequence number for this event

 - + - - + + - + @@ -2855,12 +2855,12 @@

metricsType: object
No Additional Properties - + - - + + - +
@@ -2898,12 +2898,12 @@

mem_total_mb

Type: number
- + - - + + - +
@@ -2945,12 +2945,12 @@

mem_free_mbType: number
- + - - + + - + @@ -2992,12 +2992,12 @@

store_total_mbType: number
- + - - + + - + @@ -3039,12 +3039,12 @@

store_free_mbType: number
- + - - + + - + @@ -3086,12 +3086,12 @@

system_loadType: number
- + - - + + - + @@ -3125,17 +3125,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - pointsetType: object
+ pointset

Pointset Events

Type: object

A set of points reporting telemetry data. Pointset Events Documentation

 No Additional Properties - + - - + + - +
@@ -3164,15 +3164,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -3212,12 +3212,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -3253,12 +3253,12 @@

upgraded_fromType: string

Original version of schema pre-upgrade

 - + - - + + - + @@ -3294,12 +3294,12 @@

partial_updateType: boolean

Indicates if this is a partial update (only some points may be included)

 - + - - + + - + @@ -3335,18 +3335,18 @@

pointsType: object

Collection of point names, defining the representative point set for this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1" onclick="setAnchor('#pointset_points_pattern1')">Point Pointset Events Pattern Property

@@ -3356,7 +3356,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -3381,17 +3381,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - events_pointset_point.json#

Type: object
+ Point Pointset Events

Point Pointset Events

Type: object

Object representation for for a single point

 No Additional Properties - + - - + + - +
@@ -3437,12 +3437,12 @@

present_value

Type: object

The specific point data reading

 - + - - + + -
+
Examples:

24.1
@@ -3488,17 +3488,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery

Type: object
+ discovery

Discovery Events

Type: object

Discovery result with implicit discovery

 No Additional Properties - + - - + + - +
@@ -3527,15 +3527,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the discover telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -3575,12 +3575,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -3613,15 +3613,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The event's discovery scan trigger's generation timestamp

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -3658,16 +3658,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -3706,12 +3706,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -3758,12 +3758,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -3803,7 +3803,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -4035,12 +4035,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -4082,12 +4082,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -4129,12 +4129,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -4176,12 +4176,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -4223,12 +4223,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -4270,12 +4270,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -4317,12 +4317,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -4364,12 +4364,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -4411,12 +4411,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -4458,12 +4458,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -4505,12 +4505,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -4552,12 +4552,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -4599,12 +4599,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -4646,12 +4646,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -4693,12 +4693,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -4740,12 +4740,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -4787,12 +4787,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -4834,12 +4834,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -4881,12 +4881,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -4928,12 +4928,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -4975,12 +4975,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -5022,12 +5022,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -5069,12 +5069,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -5116,12 +5116,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -5163,12 +5163,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -5210,12 +5210,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -5257,12 +5257,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -5304,12 +5304,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -5351,12 +5351,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -5398,12 +5398,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -5445,12 +5445,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -5492,12 +5492,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -5539,12 +5539,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -5586,12 +5586,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -5633,12 +5633,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -5680,12 +5680,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -5727,19 +5727,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -5779,15 +5779,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -5834,12 +5834,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -5882,12 +5882,12 @@

family

Type: object
- + - - + + - + @@ -5923,12 +5923,12 @@

addrType: string

The primary address of the device (for indicated family)

 - + - - + + - + @@ -5964,12 +5964,12 @@

event_noType: integer

The active or passive series number of this result (matches reported state values)

 - + - - + + - + @@ -6005,18 +6005,18 @@

familiesType: object

Links to other address families (family and id)

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_families_pattern1" onclick="setAnchor('#discovery_families_pattern1')">Family Discovery Pattern Property

@@ -6026,7 +6026,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -6051,17 +6051,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -6107,12 +6107,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -6162,12 +6162,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -6211,18 +6211,18 @@

registriesType: object

Registry iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_registries_pattern1" onclick="setAnchor('#discovery_registries_pattern1')">Cloud Model Pattern Property

@@ -6232,7 +6232,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -6257,17 +6257,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -6313,12 +6313,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -6368,15 +6368,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -6426,15 +6426,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -6484,12 +6484,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -6539,15 +6539,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -6594,17 +6594,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -6657,12 +6657,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -6720,17 +6720,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -6790,12 +6790,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -6862,12 +6862,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -6883,7 +6883,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -6938,12 +6938,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -7011,12 +7011,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -7080,12 +7080,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -7148,12 +7148,12 @@

familyType: string
- + - - + + - + @@ -7214,12 +7214,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -7268,12 +7268,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -7332,17 +7332,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -7395,12 +7395,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -7453,12 +7453,12 @@

blockedType: boolean
- + - - + + - + @@ -7507,12 +7507,12 @@

detailType: string
- + - - + + - + @@ -7559,14 +7559,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -7613,14 +7613,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -7667,14 +7667,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -7721,14 +7721,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -7777,12 +7777,12 @@

num_idType: string
- + - - + + - + @@ -7831,15 +7831,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -7889,12 +7889,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -7944,12 +7944,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -7965,7 +7965,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -8006,12 +8006,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -8059,18 +8059,18 @@

devicesType: object

Device iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_devices_pattern1" onclick="setAnchor('#discovery_devices_pattern1')">Cloud Model Pattern Property

@@ -8080,7 +8080,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -8105,17 +8105,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -8161,12 +8161,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -8216,15 +8216,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -8274,15 +8274,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -8332,12 +8332,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -8387,15 +8387,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -8442,17 +8442,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -8505,12 +8505,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -8568,17 +8568,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -8638,12 +8638,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -8710,12 +8710,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -8731,7 +8731,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -8786,12 +8786,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -8859,12 +8859,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -8928,12 +8928,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -8996,12 +8996,12 @@

familyType: string
- + - - + + - + @@ -9062,12 +9062,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -9116,12 +9116,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -9180,17 +9180,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -9243,12 +9243,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -9301,12 +9301,12 @@

blockedType: boolean
- + - - + + - + @@ -9355,12 +9355,12 @@

detailType: string
- + - - + + - + @@ -9407,14 +9407,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -9461,14 +9461,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -9515,14 +9515,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -9569,14 +9569,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -9625,12 +9625,12 @@

num_idType: string
- + - - + + - + @@ -9679,15 +9679,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -9737,12 +9737,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -9792,12 +9792,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -9813,7 +9813,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -9854,12 +9854,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -9907,18 +9907,18 @@

pointsType: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_points_pattern1" onclick="setAnchor('#discovery_points_pattern1')">Point Pointset Model Pattern Property

@@ -9928,7 +9928,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -9953,17 +9953,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_pointset_point.json#

Type: object
+ Point Pointset Model

Point Pointset Model

Type: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +
@@ -10009,12 +10009,12 @@

units

Type: string

Expected unit configuration for the point

 - + - - + + - +
@@ -10064,12 +10064,12 @@

descriptionType: string

Detailed description of this point

 - + - - + + - + @@ -10119,12 +10119,12 @@

writableType: boolean

Indicates if this point is writable (else read-only)

 - + - - + + - + @@ -10174,12 +10174,12 @@

baseline_valueType: object

Represents the expected baseline value of the point

 - + - - + + -
+
Example:

22
@@ -10233,12 +10233,12 @@

baseline_tolerance

Type: number

Maximum deviation from baseline_value

 - + - - + + -
+
Example:

2
@@ -10292,15 +10292,15 @@

baseline_state

Type: enum (of string)

Expected state when baseline_value is set as the set_value for this point the config message

-

Must be one of:

-
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- +

Must be one of:

+ + + - - + + - + @@ -10350,12 +10350,12 @@

range_minType: number

Represents the lower bound of the error threshold for a point

 - + - - + + -
+
Example:

0
@@ -10409,12 +10409,12 @@

range_max

Type: number

Represents the upper bound of the error threshold for a point

 - + - - + + -
+
Example:

100
@@ -10468,12 +10468,12 @@

cov_increment

Type: number

Triggering threshold for partial cov update publishing

 - + - - + + -
+
Example:

1
@@ -10527,12 +10527,12 @@

ref

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)

 - + - - + + -
+
Examples:

"AI3"
@@ -10587,12 +10587,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -10608,7 +10608,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -10649,12 +10649,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -10708,12 +10708,12 @@

tagsType: array

Tags assosciated with the point

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -10755,12 +10755,12 @@

tags items

Type: object
Must match regular expression: ^[a-z0-9]+$ - + - - + + - +

Examples:
@@ -10823,18 +10823,18 @@

structureType: object

Collection of family point information

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_points_pattern1_structure_pattern1" onclick="setAnchor('#discovery_points_pattern1_structure_pattern1')">Ref Discovery Pattern Property

@@ -10844,7 +10844,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -10883,17 +10883,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -10953,12 +10953,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -11022,12 +11022,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -11091,12 +11091,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -11152,12 +11152,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -11223,12 +11223,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -11292,12 +11292,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -11361,12 +11361,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -11430,12 +11430,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -11499,12 +11499,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -11565,16 +11565,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -11641,12 +11641,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -11721,12 +11721,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -11794,7 +11794,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -12054,12 +12054,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -12129,12 +12129,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -12204,12 +12204,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -12279,12 +12279,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -12354,12 +12354,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -12429,12 +12429,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -12504,12 +12504,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -12579,12 +12579,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -12654,12 +12654,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -12729,12 +12729,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -12804,12 +12804,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -12879,12 +12879,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -12954,12 +12954,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -13029,12 +13029,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -13104,12 +13104,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -13179,12 +13179,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -13254,12 +13254,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -13329,12 +13329,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -13404,12 +13404,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -13479,12 +13479,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -13554,12 +13554,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -13629,12 +13629,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -13704,12 +13704,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -13779,12 +13779,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -13854,12 +13854,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -13929,12 +13929,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -14004,12 +14004,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -14079,12 +14079,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -14154,12 +14154,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -14229,12 +14229,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -14304,12 +14304,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -14379,12 +14379,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -14454,12 +14454,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -14529,12 +14529,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -14604,12 +14604,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -14679,12 +14679,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -14754,19 +14754,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -14834,15 +14834,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -14917,12 +14917,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -14991,17 +14991,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -15064,12 +15064,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -15085,7 +15085,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -15140,12 +15140,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -15212,12 +15212,12 @@

structureType: object
- + - - + + - +
@@ -15281,17 +15281,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -15365,12 +15365,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -15448,12 +15448,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -15528,18 +15528,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_points_pattern1_structure_pattern1_structure_families_pattern1" onclick="setAnchor('#discovery_points_pattern1_structure_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -15549,7 +15549,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -15609,17 +15609,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -15700,12 +15700,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -15790,12 +15790,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -15859,18 +15859,18 @@

refsType: object

Collection of point references

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_refs_pattern1" onclick="setAnchor('#discovery_refs_pattern1')">Ref Discovery Pattern Property

@@ -15880,7 +15880,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -15905,17 +15905,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -15961,12 +15961,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -16016,12 +16016,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -16071,12 +16071,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -16118,12 +16118,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -16175,12 +16175,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -16230,12 +16230,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -16285,12 +16285,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -16340,12 +16340,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -16395,12 +16395,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -16447,16 +16447,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -16509,12 +16509,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -16575,12 +16575,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -16634,7 +16634,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -16880,12 +16880,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -16941,12 +16941,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -17002,12 +17002,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -17063,12 +17063,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -17124,12 +17124,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -17185,12 +17185,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -17246,12 +17246,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -17307,12 +17307,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -17368,12 +17368,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -17429,12 +17429,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -17490,12 +17490,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -17551,12 +17551,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -17612,12 +17612,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -17673,12 +17673,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -17734,12 +17734,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -17795,12 +17795,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -17856,12 +17856,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -17917,12 +17917,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -17978,12 +17978,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -18039,12 +18039,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -18100,12 +18100,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -18161,12 +18161,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -18222,12 +18222,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -18283,12 +18283,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -18344,12 +18344,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -18405,12 +18405,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -18466,12 +18466,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -18527,12 +18527,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -18588,12 +18588,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - - - - + - + + + +
@@ -18649,12 +18649,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -18710,12 +18710,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -18771,12 +18771,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -18832,12 +18832,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -18893,12 +18893,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -18954,12 +18954,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -19015,12 +19015,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -19076,19 +19076,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -19142,15 +19142,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -19211,12 +19211,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -19271,17 +19271,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -19330,12 +19330,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -19351,7 +19351,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -19392,12 +19392,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -19450,12 +19450,12 @@

structureType: object
- + - - + + - +
@@ -19505,17 +19505,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -19575,12 +19575,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -19644,12 +19644,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -19710,18 +19710,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_refs_pattern1_structure_families_pattern1" onclick="setAnchor('#discovery_refs_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -19731,7 +19731,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -19777,17 +19777,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -19854,12 +19854,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -19930,12 +19930,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -19991,18 +19991,18 @@

featuresType: object

Discovery of features supported by this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_features_pattern1" onclick="setAnchor('#discovery_features_pattern1')">Feature Discovery Pattern Property

@@ -20012,7 +20012,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[._a-zA-Z]+$
@@ -20037,17 +20037,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_feature.json

Type: object
+ Feature Discovery

Feature Discovery

Type: object

Object representation for for a single feature

 No Additional Properties - + - - + + - +
@@ -20090,20 +20090,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
- +

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ - - + + - +
@@ -20144,17 +20144,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - cloud_modelType: object
+ cloud_model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -20193,12 +20193,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -20241,15 +20241,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -20292,15 +20292,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -20343,12 +20343,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -20391,15 +20391,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -20439,17 +20439,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - - - - + - + + + +
@@ -20495,12 +20495,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -20551,17 +20551,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -20614,12 +20614,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -20679,12 +20679,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -20700,7 +20700,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -20748,12 +20748,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -20814,12 +20814,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -20876,12 +20876,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -20937,12 +20937,12 @@

familyType: string
- + - - + + - + @@ -20996,12 +20996,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -21043,12 +21043,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -21100,17 +21100,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -21156,12 +21156,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -21207,12 +21207,12 @@

blockedType: boolean
- + - - + + - + @@ -21254,12 +21254,12 @@

detailType: string
- + - - + + - + @@ -21299,14 +21299,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -21346,14 +21346,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -21393,14 +21393,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -21440,14 +21440,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -21489,12 +21489,12 @@

num_idType: string
- + - - + + - + @@ -21536,15 +21536,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -21587,12 +21587,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -21635,12 +21635,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -21656,7 +21656,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -21690,12 +21690,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -21736,14 +21736,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System Discovery Data

Type: object
No Additional Properties - + - - + + - +
@@ -21782,12 +21782,12 @@

description

Type: string

Full textual desctiiption of this device

 - + - - + + - +
@@ -21830,12 +21830,12 @@

nameType: string

Friendly name of this device

 - + - - + + - + @@ -21878,12 +21878,12 @@

serial_noType: string

The serial number of the physical device

 - + - - + + - + @@ -21923,17 +21923,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillaryType: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -21973,17 +21973,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - hardwareType: object
+ hardware

State System Hardware

Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties - + - - + + - +
@@ -22029,12 +22029,12 @@

make

Type: string

The manufacturer of the device

 - + - - + + -
+
Example:

"Google"
@@ -22088,12 +22088,12 @@

model

Type: string

The model of the device

 - + - - + + -
+
Examples:

"Pixel 5"
@@ -22151,12 +22151,12 @@

sku

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations

 - + - - + + -
+
Examples:

"GF5KQ"
@@ -22212,12 +22212,12 @@

rev

Type: string

Hardware revision of the device

 - + - - + + -
+
Examples:

"A"
diff --git a/gencode/docs/events_discovery.html b/gencode/docs/events_discovery.html index 4c6b221b94..aeeca3f606 100644 --- a/gencode/docs/events_discovery.html +++ b/gencode/docs/events_discovery.html @@ -15,20 +15,20 @@ Discovery Events -

Discovery Events

+
-
Type: object
+

Discovery Events

Type: object

Discovery result with implicit discovery

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the discover telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -122,15 +122,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generation
Type: stringFormat: date-time

The event's discovery scan trigger's generation timestamp

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -160,16 +160,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -201,12 +201,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -246,12 +246,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -284,7 +284,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -509,12 +509,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -549,12 +549,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -589,12 +589,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -629,12 +629,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -669,12 +669,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -709,12 +709,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -749,12 +749,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -789,12 +789,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -829,12 +829,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -869,12 +869,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -909,12 +909,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -949,12 +949,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -989,12 +989,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1029,12 +1029,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1069,12 +1069,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1109,12 +1109,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1149,12 +1149,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1189,12 +1189,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1229,12 +1229,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1269,12 +1269,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1309,12 +1309,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1349,12 +1349,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1389,12 +1389,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1429,12 +1429,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1469,12 +1469,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1509,12 +1509,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1549,12 +1549,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1589,12 +1589,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1629,12 +1629,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1669,12 +1669,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -1709,12 +1709,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -1749,12 +1749,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -1789,12 +1789,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -1829,12 +1829,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -1869,12 +1869,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -1909,12 +1909,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -1949,19 +1949,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -1994,15 +1994,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2042,12 +2042,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2083,12 +2083,12 @@

family

Type: object
- + - - + + - + @@ -2117,12 +2117,12 @@

addrType: string

The primary address of the device (for indicated family)

 - + - - + + - + @@ -2151,12 +2151,12 @@

event_noType: integer

The active or passive series number of this result (matches reported state values)

 - + - - + + - + @@ -2185,18 +2185,18 @@

familiesType: object

Links to other address families (family and id)

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="families_pattern1" onclick="setAnchor('#families_pattern1')">Family Discovery Pattern Property

@@ -2206,7 +2206,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -2224,17 +2224,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -2273,12 +2273,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -2321,12 +2321,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -2363,18 +2363,18 @@

registriesType: object

Registry iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="registries_pattern1" onclick="setAnchor('#registries_pattern1')">Cloud Model Pattern Property

@@ -2384,7 +2384,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -2402,17 +2402,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -2451,12 +2451,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -2499,15 +2499,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -2550,15 +2550,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -2601,12 +2601,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -2649,15 +2649,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -2697,17 +2697,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -2753,12 +2753,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -2809,17 +2809,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -2872,12 +2872,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -2937,12 +2937,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -2958,7 +2958,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -3006,12 +3006,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -3072,12 +3072,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -3134,12 +3134,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -3195,12 +3195,12 @@

familyType: string
- + - - + + - + @@ -3254,12 +3254,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -3301,12 +3301,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -3358,17 +3358,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -3414,12 +3414,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -3465,12 +3465,12 @@

blockedType: boolean
- + - - + + - + @@ -3512,12 +3512,12 @@

detailType: string
- + - - + + - + @@ -3557,14 +3557,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -3604,14 +3604,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -3651,14 +3651,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -3698,14 +3698,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -3747,12 +3747,12 @@

num_idType: string
- + - - + + - + @@ -3794,15 +3794,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -3845,12 +3845,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -3893,12 +3893,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -3914,7 +3914,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -3948,12 +3948,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -3994,18 +3994,18 @@

devicesType: object

Device iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="devices_pattern1" onclick="setAnchor('#devices_pattern1')">Cloud Model Pattern Property

@@ -4015,7 +4015,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -4033,17 +4033,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -4082,12 +4082,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -4130,15 +4130,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -4181,15 +4181,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -4232,12 +4232,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -4280,15 +4280,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -4328,17 +4328,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -4384,12 +4384,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -4440,17 +4440,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -4503,12 +4503,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -4568,12 +4568,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -4589,7 +4589,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -4637,12 +4637,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -4703,12 +4703,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -4765,12 +4765,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -4826,12 +4826,12 @@

familyType: string
- + - - + + - + @@ -4885,12 +4885,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -4932,12 +4932,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -4989,17 +4989,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -5045,12 +5045,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -5096,12 +5096,12 @@

blockedType: boolean
- + - - + + - + @@ -5143,12 +5143,12 @@

detailType: string
- + - - + + - + @@ -5188,14 +5188,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -5235,14 +5235,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -5282,14 +5282,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -5329,14 +5329,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -5378,12 +5378,12 @@

num_idType: string
- + - - + + - + @@ -5425,15 +5425,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -5476,12 +5476,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -5524,12 +5524,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -5545,7 +5545,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -5579,12 +5579,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -5625,18 +5625,18 @@

pointsType: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="points_pattern1" onclick="setAnchor('#points_pattern1')">Point Pointset Model Pattern Property

@@ -5646,7 +5646,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -5664,17 +5664,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_pointset_point.json#

Type: object
+ Point Pointset Model

Point Pointset Model

Type: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +
@@ -5713,12 +5713,12 @@

units

Type: string

Expected unit configuration for the point

 - + - - + + - +
@@ -5761,12 +5761,12 @@

descriptionType: string

Detailed description of this point

 - + - - + + - + @@ -5809,12 +5809,12 @@

writableType: boolean

Indicates if this point is writable (else read-only)

 - + - - + + - + @@ -5857,12 +5857,12 @@

baseline_valueType: object

Represents the expected baseline value of the point

 - + - - + + -
+
Example:

22
@@ -5909,12 +5909,12 @@

baseline_tolerance

Type: number

Maximum deviation from baseline_value

 - + - - + + -
+
Example:

2
@@ -5961,15 +5961,15 @@

baseline_state

Type: enum (of string)

Expected state when baseline_value is set as the set_value for this point the config message

-

Must be one of:

-
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- +

Must be one of:

+ + + - - + + - + @@ -6012,12 +6012,12 @@

range_minType: number

Represents the lower bound of the error threshold for a point

 - + - - + + -
+
Example:

0
@@ -6064,12 +6064,12 @@

range_max

Type: number

Represents the upper bound of the error threshold for a point

 - + - - + + -
+
Example:

100
@@ -6116,12 +6116,12 @@

cov_increment

Type: number

Triggering threshold for partial cov update publishing

 - + - - + + -
+
Example:

1
@@ -6168,12 +6168,12 @@

ref

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)

 - + - - + + -
+
Examples:

"AI3"
@@ -6221,12 +6221,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -6242,7 +6242,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -6276,12 +6276,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -6328,12 +6328,12 @@

tagsType: array

Tags assosciated with the point

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -6368,12 +6368,12 @@

tags items

Type: object
Must match regular expression: ^[a-z0-9]+$ - + - - + + - +

Examples:
@@ -6429,18 +6429,18 @@

structureType: object

Collection of family point information

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="points_pattern1_structure_pattern1" onclick="setAnchor('#points_pattern1_structure_pattern1')">Ref Discovery Pattern Property

@@ -6450,7 +6450,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -6482,17 +6482,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -6545,12 +6545,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -6607,12 +6607,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -6669,12 +6669,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -6723,12 +6723,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -6787,12 +6787,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -6849,12 +6849,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -6911,12 +6911,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -6973,12 +6973,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -7035,12 +7035,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -7094,16 +7094,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -7163,12 +7163,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -7236,12 +7236,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -7302,7 +7302,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -7555,12 +7555,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -7623,12 +7623,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -7691,12 +7691,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -7759,12 +7759,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -7827,12 +7827,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -7895,12 +7895,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -7963,12 +7963,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -8031,12 +8031,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -8099,12 +8099,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -8167,12 +8167,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -8235,12 +8235,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -8303,12 +8303,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -8371,12 +8371,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -8439,12 +8439,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -8507,12 +8507,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -8575,12 +8575,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -8643,12 +8643,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -8711,12 +8711,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -8779,12 +8779,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -8847,12 +8847,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -8915,12 +8915,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -8983,12 +8983,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -9051,12 +9051,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -9119,12 +9119,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -9187,12 +9187,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -9255,12 +9255,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -9323,12 +9323,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -9391,12 +9391,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -9459,12 +9459,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -9527,12 +9527,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -9595,12 +9595,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -9663,12 +9663,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -9731,12 +9731,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -9799,12 +9799,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -9867,12 +9867,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -9935,12 +9935,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -10003,19 +10003,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -10076,15 +10076,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -10152,12 +10152,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -10219,17 +10219,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -10285,12 +10285,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -10306,7 +10306,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -10354,12 +10354,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -10419,12 +10419,12 @@

structureType: object
- + - - + + - +
@@ -10481,17 +10481,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -10558,12 +10558,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -10634,12 +10634,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -10707,18 +10707,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="points_pattern1_structure_pattern1_structure_families_pattern1" onclick="setAnchor('#points_pattern1_structure_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -10728,7 +10728,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -10781,17 +10781,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -10865,12 +10865,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -10948,12 +10948,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -11010,18 +11010,18 @@

refsType: object

Collection of point references

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="refs_pattern1" onclick="setAnchor('#refs_pattern1')">Ref Discovery Pattern Property

@@ -11031,7 +11031,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -11049,17 +11049,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -11098,12 +11098,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -11146,12 +11146,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -11194,12 +11194,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -11234,12 +11234,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -11284,12 +11284,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -11332,12 +11332,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -11380,12 +11380,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -11428,12 +11428,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -11476,12 +11476,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -11521,16 +11521,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -11576,12 +11576,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -11635,12 +11635,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -11687,7 +11687,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -11926,12 +11926,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -11980,12 +11980,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -12034,12 +12034,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -12088,12 +12088,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -12142,12 +12142,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -12196,12 +12196,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -12250,12 +12250,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -12304,12 +12304,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -12358,12 +12358,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -12412,12 +12412,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -12466,12 +12466,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -12520,12 +12520,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -12574,12 +12574,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -12628,12 +12628,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -12682,12 +12682,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -12736,12 +12736,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -12790,12 +12790,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -12844,12 +12844,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -12898,12 +12898,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -12952,12 +12952,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -13006,12 +13006,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -13060,12 +13060,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -13114,12 +13114,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -13168,12 +13168,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -13222,12 +13222,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -13276,12 +13276,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -13330,12 +13330,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -13384,12 +13384,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -13438,12 +13438,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - - - - + - + + + +
@@ -13492,12 +13492,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -13546,12 +13546,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -13600,12 +13600,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -13654,12 +13654,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -13708,12 +13708,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -13762,12 +13762,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -13816,12 +13816,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -13870,19 +13870,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -13929,15 +13929,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -13991,12 +13991,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -14044,17 +14044,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -14096,12 +14096,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -14117,7 +14117,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -14151,12 +14151,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -14202,12 +14202,12 @@

structureType: object
- + - - + + - +
@@ -14250,17 +14250,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -14313,12 +14313,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -14375,12 +14375,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -14434,18 +14434,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="refs_pattern1_structure_families_pattern1" onclick="setAnchor('#refs_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -14455,7 +14455,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -14494,17 +14494,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -14564,12 +14564,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -14633,12 +14633,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -14687,18 +14687,18 @@

featuresType: object

Discovery of features supported by this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="features_pattern1" onclick="setAnchor('#features_pattern1')">Feature Discovery Pattern Property

@@ -14708,7 +14708,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[._a-zA-Z]+$
@@ -14726,17 +14726,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_feature.json

Type: object
+ Feature Discovery

Feature Discovery

Type: object

Object representation for for a single feature

 No Additional Properties - + - - + + - +
@@ -14772,20 +14772,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
- +

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ - - + + - +
@@ -14819,17 +14819,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - cloud_modelType: object
+ cloud_model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -14861,12 +14861,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -14902,15 +14902,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -14946,15 +14946,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -14990,12 +14990,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -15031,15 +15031,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -15072,17 +15072,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - - - - + - + + + +
@@ -15121,12 +15121,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -15170,17 +15170,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -15226,12 +15226,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -15284,12 +15284,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -15305,7 +15305,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -15346,12 +15346,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -15405,12 +15405,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -15460,12 +15460,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -15514,12 +15514,12 @@

familyType: string
- + - - + + - + @@ -15566,12 +15566,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -15606,12 +15606,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -15656,17 +15656,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -15705,12 +15705,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -15749,12 +15749,12 @@

blockedType: boolean
- + - - + + - + @@ -15789,12 +15789,12 @@

detailType: string
- + - - + + - + @@ -15827,14 +15827,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -15867,14 +15867,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -15907,14 +15907,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -15947,14 +15947,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -15989,12 +15989,12 @@

num_idType: string
- + - - + + - + @@ -16029,15 +16029,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -16073,12 +16073,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -16114,12 +16114,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -16135,7 +16135,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -16162,12 +16162,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -16201,14 +16201,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System Discovery Data

Type: object
No Additional Properties - + - - + + - +
@@ -16240,12 +16240,12 @@

description

Type: string

Full textual desctiiption of this device

 - + - - + + - +
@@ -16281,12 +16281,12 @@

nameType: string

Friendly name of this device

 - + - - + + - + @@ -16322,12 +16322,12 @@

serial_noType: string

The serial number of the physical device

 - + - - + + - + @@ -16360,17 +16360,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillaryType: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -16403,17 +16403,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - hardwareType: object
+ hardware

State System Hardware

Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties - + - - + + - +
@@ -16452,12 +16452,12 @@

make

Type: string

The manufacturer of the device

 - + - - + + -
+
Example:

"Google"
@@ -16504,12 +16504,12 @@

model

Type: string

The model of the device

 - + - - + + -
+
Examples:

"Pixel 5"
@@ -16560,12 +16560,12 @@

sku

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations

 - + - - + + -
+
Examples:

"GF5KQ"
@@ -16614,12 +16614,12 @@

rev

Type: string

Hardware revision of the device

 - + - - + + -
+
Examples:

"A"
diff --git a/gencode/docs/events_mapping.html b/gencode/docs/events_mapping.html index b189b007fd..2b6467f742 100644 --- a/gencode/docs/events_mapping.html +++ b/gencode/docs/events_mapping.html @@ -15,20 +15,20 @@ Mapping Events -

Mapping Events

+
-
Type: object
+

Mapping Events

Type: object

Mapping result with implicit enumeration

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 timestamp the configuration was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -122,16 +122,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -163,12 +163,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -208,12 +208,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -246,7 +246,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -471,12 +471,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -511,12 +511,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -551,12 +551,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -591,12 +591,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -631,12 +631,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -671,12 +671,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -711,12 +711,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -751,12 +751,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -791,12 +791,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -831,12 +831,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -871,12 +871,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -911,12 +911,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -951,12 +951,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -991,12 +991,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1031,12 +1031,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1071,12 +1071,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1111,12 +1111,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1151,12 +1151,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1191,12 +1191,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1231,12 +1231,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1271,12 +1271,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1311,12 +1311,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1351,12 +1351,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1391,12 +1391,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1431,12 +1431,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1471,12 +1471,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1511,12 +1511,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1551,12 +1551,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1591,12 +1591,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1631,12 +1631,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -1671,12 +1671,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -1711,12 +1711,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -1751,12 +1751,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -1791,12 +1791,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -1831,12 +1831,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -1871,12 +1871,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -1911,19 +1911,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -1956,15 +1956,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2004,12 +2004,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2043,23 +2043,23 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entities

Type: object
+ entities

Mapping Events Entities

Type: object

Mapper output describing a group of devices by their guids

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="entities_pattern1" onclick="setAnchor('#entities_pattern1')">Mapping Event Entity Pattern Property

@@ -2069,7 +2069,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-0-9a-z]+$
@@ -2087,16 +2087,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - events_mapping_entity.json

Type: object
+ Mapping Event Entity

Mapping Event Entity

Type: object
No Additional Properties - + - - + + - +
@@ -2135,12 +2135,12 @@

code

Type: string

Human readable code for the entity, should be unique in the document scope

Must match regular expression: ^[-_A-Za-z0-9]+$ - + - - + + -
+
Example:

"fcu-8_1"
@@ -2187,12 +2187,12 @@

type

Type: string

DBO namespace and entity type

Must match regular expression: ^([_A-Z]+/)?[_A-Z]+$ - + - - + + -
+
Example:

"HVAC/FCU_DFSS_DSP_CHWZC"
@@ -2239,12 +2239,12 @@

cloud_device_id

Type: string

Opaque identifier for the entity

Must match regular expression: ^[0-9]+$ - + - - + + -
+
Example:

"3607425"
@@ -2291,12 +2291,12 @@

connections

Type: object

Entity connections, keyed by guid

 - + - - + + -
+
Example:

{
     "dea1fcd5-6942-47a2-ba75-448a7ed47fd7": "CONTAINS"
@@ -2318,7 +2318,7 @@ 

             

                         
                     

-                    
All property whose name matches the following regular expression must respect the following conditions

+                    
All properties whose name matches the following regular expression must respect the following conditions

                     Property name regular expression: ^[-0-9a-z]+$
                     

 
@@ -2351,16 +2351,16 @@ 

             />
         
     ^[-0-9a-z]+$
Type: enum (of string)

-

-                
Must be one of:

-                
  • "CONTAINS"

-                

-            
+

+            
Must be one of:

+            
  • "CONTAINS"

+            

+        
 
-            
-            
+        
+        
 
-            
+
@@ -2404,17 +2404,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - links

Type: object
+ links

Virtual Equipment Links

Type: object

Virtual equipment mapping, keyed by guid

 No Additional Properties - + - - + + - + @@ -2830,12 +2830,12 @@

statesType: object
- + - - + + - + @@ -2886,12 +2886,12 @@

missing_telemetry_fieldsType: array of string

DBO fields which are required by the type but absent from the translation

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -2926,12 +2926,12 @@

Each item of this array must be:

missing_telemetry_fields items
Type: string
Must match regular expression: ^[a-z_]+$ - + - - + + - +

Example:
diff --git a/gencode/docs/events_pointset.html b/gencode/docs/events_pointset.html index 6246bc1d9b..644d49dc40 100644 --- a/gencode/docs/events_pointset.html +++ b/gencode/docs/events_pointset.html @@ -15,20 +15,20 @@ Pointset Events -

Pointset Events

+
-
Type: object
+

Pointset Events

Type: object

A set of points reporting telemetry data. Pointset Events Documentation

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,12 +125,12 @@

upgraded_fromType: string

Original version of schema pre-upgrade

 - + - - + + - + @@ -159,12 +159,12 @@

partial_updateType: boolean

Indicates if this is a partial update (only some points may be included)

 - + - - + + - + @@ -193,18 +193,18 @@

pointsType: object

Collection of point names, defining the representative point set for this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="points_pattern1" onclick="setAnchor('#points_pattern1')">Point Pointset Events Pattern Property

@@ -214,7 +214,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -232,17 +232,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - events_pointset_point.json#

Type: object
+ Point Pointset Events

Point Pointset Events

Type: object

Object representation for for a single point

 No Additional Properties - + - - + + - +
@@ -281,12 +281,12 @@

present_value

Type: object

The specific point data reading

 - + - - + + -
+
Examples:

24.1
diff --git a/gencode/docs/events_system.html b/gencode/docs/events_system.html index 2f66eb34db..6f6a3c2964 100644 --- a/gencode/docs/events_system.html +++ b/gencode/docs/events_system.html @@ -15,20 +15,20 @@ System Events -

System Events

+
-
Type: object
+

System Events

Type: object

Used for system events such as logging. System Event Documentation

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the event payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,12 +125,12 @@

upgraded_from

Type: string

Original version of schema pre-upgrade

 - + - - + + - +
@@ -156,15 +156,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_configType: string
+ last_configType: stringFormat: date-time

Last config received

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -196,12 +196,12 @@

logentries

Type: array
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -220,16 +220,16 @@

Each item of this array must be:

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entry.json
Type: object
+ Entry

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -268,12 +268,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -320,12 +320,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -365,7 +365,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -597,12 +597,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -644,12 +644,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -691,12 +691,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -738,12 +738,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -785,12 +785,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -832,12 +832,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -879,12 +879,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -926,12 +926,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -973,12 +973,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1020,12 +1020,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1067,12 +1067,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1114,12 +1114,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1161,12 +1161,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1208,12 +1208,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1255,12 +1255,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1302,12 +1302,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1349,12 +1349,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1396,12 +1396,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1443,12 +1443,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1490,12 +1490,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1537,12 +1537,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1584,12 +1584,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1631,12 +1631,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1678,12 +1678,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1725,12 +1725,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1772,12 +1772,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1819,12 +1819,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1866,12 +1866,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1913,12 +1913,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1960,12 +1960,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2007,12 +2007,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2054,12 +2054,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2101,12 +2101,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2148,12 +2148,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2195,12 +2195,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2242,12 +2242,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2289,19 +2289,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2341,15 +2341,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2396,12 +2396,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2440,12 +2440,12 @@

event_no

Type: integer

Sequence number for this event

 - + - - + + - + @@ -2473,12 +2473,12 @@

metricsType: object
No Additional Properties - + - - + + - +
@@ -2509,12 +2509,12 @@

mem_total_mb

Type: number
- + - - + + - +
@@ -2549,12 +2549,12 @@

mem_free_mbType: number
- + - - + + - + @@ -2589,12 +2589,12 @@

store_total_mbType: number
- + - - + + - + @@ -2629,12 +2629,12 @@

store_free_mbType: number
- + - - + + - + @@ -2669,12 +2669,12 @@

system_loadType: number
- + - - + + - + diff --git a/gencode/docs/events_udmi.html b/gencode/docs/events_udmi.html index b6f21bf189..9051ebca31 100644 --- a/gencode/docs/events_udmi.html +++ b/gencode/docs/events_udmi.html @@ -15,20 +15,20 @@ Udmi Events -

Udmi Events

+
-
Type: object
+

Udmi Events

Type: object

Used for udmi events such as logging.

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the event payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -124,12 +124,12 @@

logentriesType: array
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -148,16 +148,16 @@

Each item of this array must be:

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entry.json
Type: object
+ Entry

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -196,12 +196,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -248,12 +248,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -293,7 +293,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -525,12 +525,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -572,12 +572,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -619,12 +619,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -666,12 +666,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -713,12 +713,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -760,12 +760,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -807,12 +807,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -854,12 +854,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -901,12 +901,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -948,12 +948,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -995,12 +995,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1042,12 +1042,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1089,12 +1089,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1136,12 +1136,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1183,12 +1183,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1230,12 +1230,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1277,12 +1277,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1324,12 +1324,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1371,12 +1371,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1418,12 +1418,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1465,12 +1465,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1512,12 +1512,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1559,12 +1559,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1606,12 +1606,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1653,12 +1653,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1700,12 +1700,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1747,12 +1747,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1794,12 +1794,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1841,12 +1841,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1888,12 +1888,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -1935,12 +1935,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -1982,12 +1982,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2029,12 +2029,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2076,12 +2076,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2123,12 +2123,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2170,12 +2170,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2217,19 +2217,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2269,15 +2269,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2324,12 +2324,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
diff --git a/gencode/docs/events_validation.html b/gencode/docs/events_validation.html index 51eb0d9098..2af01eb25f 100644 --- a/gencode/docs/events_validation.html +++ b/gencode/docs/events_validation.html @@ -15,20 +15,20 @@ Validation Events -

Validation Events

+
-
Type: object
+

Validation Events

Type: object

Validation device result

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the validation event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -125,12 +125,12 @@

sub_folderType: string

Subfolder of the validated message

 - + - - + + - + @@ -159,12 +159,12 @@

sub_typeType: string

Subtype of the validated message

 - + - - + + - + @@ -190,16 +190,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -231,12 +231,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -276,12 +276,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -314,7 +314,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -539,12 +539,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -579,12 +579,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -619,12 +619,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -659,12 +659,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -699,12 +699,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -739,12 +739,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -779,12 +779,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -819,12 +819,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -859,12 +859,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -899,12 +899,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -939,12 +939,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -979,12 +979,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1019,12 +1019,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1059,12 +1059,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1099,12 +1099,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1139,12 +1139,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1179,12 +1179,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1219,12 +1219,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1259,12 +1259,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1299,12 +1299,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1339,12 +1339,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1379,12 +1379,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1419,12 +1419,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1459,12 +1459,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -1499,12 +1499,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -1539,12 +1539,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -1579,12 +1579,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -1619,12 +1619,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -1659,12 +1659,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -1699,12 +1699,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -1739,12 +1739,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -1779,12 +1779,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -1819,12 +1819,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -1859,12 +1859,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -1899,12 +1899,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -1939,12 +1939,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -1979,19 +1979,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2024,15 +2024,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2072,12 +2072,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2111,15 +2111,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - pointset

Type: object
+ pointset

Pointset Summary

Type: object

Errors specific to pointset handling

 No Additional Properties - + - - + + - +
@@ -2151,12 +2151,12 @@

missing

Type: array of string

Missing points discovered while validating a device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -2184,12 +2184,12 @@

Each item of this array must be:

missing items
Type: string
- + - - + + - +
@@ -2227,12 +2227,12 @@

extraType: array of string

Extra points discovered while validating a device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -2260,12 +2260,12 @@

Each item of this array must be:

extra items
Type: string
- + - - + + - +
@@ -2300,12 +2300,12 @@

errorsType: array

List of errors encountered while validating a device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -2324,16 +2324,16 @@

Each item of this array must be:

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entry.json
Type: object
+ Entry

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -2372,12 +2372,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -2424,12 +2424,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -2469,7 +2469,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -2701,12 +2701,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -2748,12 +2748,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -2795,12 +2795,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -2842,12 +2842,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -2889,12 +2889,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -2936,12 +2936,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -2983,12 +2983,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -3030,12 +3030,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -3077,12 +3077,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -3124,12 +3124,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -3171,12 +3171,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -3218,12 +3218,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -3265,12 +3265,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -3312,12 +3312,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -3359,12 +3359,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -3406,12 +3406,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -3453,12 +3453,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -3500,12 +3500,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -3547,12 +3547,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -3594,12 +3594,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -3641,12 +3641,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -3688,12 +3688,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -3735,12 +3735,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -3782,12 +3782,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -3829,12 +3829,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -3876,12 +3876,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -3923,12 +3923,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -3970,12 +3970,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -4017,12 +4017,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -4064,12 +4064,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -4111,12 +4111,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -4158,12 +4158,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -4205,12 +4205,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -4252,12 +4252,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -4299,12 +4299,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -4346,12 +4346,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -4393,19 +4393,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -4445,15 +4445,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -4500,12 +4500,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html index 6e02b3f3f5..939a1db7ff 100644 --- a/gencode/docs/metadata.html +++ b/gencode/docs/metadata.html @@ -15,20 +15,20 @@ Metadata -

Metadata

+
-
Type: object
+

Metadata

Type: object

Metadata 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

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 timestamp UTC the data was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema for this file

 - + - - + + - +
@@ -125,12 +125,12 @@

upgraded_fromType: string

Original version of the UDMI schema for this file

 - + - - + + - + @@ -159,12 +159,12 @@

hashType: string

Automatically generated field that contains the hash of file contents.

Must match regular expression: ^[0-9a-z]{8}$ - + - - + + - + @@ -190,17 +190,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - cloudType: object
+ cloud

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -232,12 +232,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -273,15 +273,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -317,15 +317,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -361,12 +361,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -402,15 +402,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -443,17 +443,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -492,12 +492,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -541,17 +541,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -597,12 +597,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -655,12 +655,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -676,7 +676,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -717,12 +717,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -776,12 +776,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -831,12 +831,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -885,12 +885,12 @@

familyType: string
- + - - + + - + @@ -937,12 +937,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -977,12 +977,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -1027,17 +1027,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -1076,12 +1076,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -1120,12 +1120,12 @@

blockedType: boolean
- + - - + + - + @@ -1160,12 +1160,12 @@

detailType: string
- + - - + + - + @@ -1198,14 +1198,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -1238,14 +1238,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -1278,14 +1278,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -1318,14 +1318,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -1360,12 +1360,12 @@

num_idType: string
- + - - + + - + @@ -1400,15 +1400,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -1444,12 +1444,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -1485,12 +1485,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -1506,7 +1506,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -1533,12 +1533,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -1572,17 +1572,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System Model

Type: object

High-level system information about the device. System Model Documentation

 No Additional Properties - + - - + + - +
@@ -1614,12 +1614,12 @@

name

Type: string

Friendly name describing this device

 - + - - + + - +
@@ -1655,12 +1655,12 @@

descriptionType: string

Generic human-readable text describing the device

 - + - - + + - + @@ -1696,12 +1696,12 @@

device_versionType: string

Version of schema supported by the device

 - + - - + + -
+
Example:

"1.5.0"
@@ -1741,12 +1741,12 @@

zone

Type: string

Aggregation of spaces, partial spaces or other zones that the device is serving

Must match regular expression: ^[-_a-zA-Z0-9]+$ - + - - + + -
+
Examples:

"Zone1"
@@ -1788,12 +1788,12 @@

tags

Type: array

Tags associated with the device

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -1821,12 +1821,12 @@

tags items

Type: object
Must match regular expression: ^[a-z0-9]+$ - + - - + + - +

Examples:
@@ -1875,12 +1875,12 @@

locationType: object

Properties of the expected physical location of the device

 No Additional Properties - + - - + + - +
@@ -1919,12 +1919,12 @@

site

Type: string

The site name according to the site model in which the device is installed in

Must match regular expression: ^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$ - + - - + + -
+
Example:

"US-SFO-XYY"
@@ -1971,12 +1971,12 @@

panel

Type: string

The reference of the panel where the device is installed in

Must match regular expression: ^[-_a-zA-Z0-9]+$ - + - - + + -
+
Examples:

"Panel123"
@@ -2024,12 +2024,12 @@

section

Type: string
Must match regular expression: ^[A-Z0-9-]+$ - + - - + + - +
@@ -2071,12 +2071,12 @@

roomType: string
Must match regular expression: ^[-_a-zA-Z0-9]+$ - + - - + + - + @@ -2119,12 +2119,12 @@

floorType: string

Name of floor level

Must match regular expression: ^[A-Z0-9-]+$ - + - - + + -
+
Examples:

"1"
@@ -2179,12 +2179,12 @@

floor_seq

Type: integer

Sequential integer representation for a floor, primarily for comparisons when non integer floors are used, e.g. 1 and 1M

 - + - - + + - + @@ -2226,12 +2226,12 @@

positionType: object
No Additional Properties - + - - + + - +
@@ -2277,12 +2277,12 @@

x

Type: number

The x coordinate of the device location in a project specific coordinate system

 - + - - + + - +
@@ -2332,12 +2332,12 @@

yType: number

The y coordinate of the device location in a project specific coordinate system

 - + - - + + - + @@ -2387,12 +2387,12 @@

zType: number

The z (height) coordinate of the device location in a project specific coordinate system

 - + - - + + - + @@ -2438,12 +2438,12 @@

coordinatesType: object
No Additional Properties - + - - + + - +
@@ -2489,12 +2489,12 @@

lat

Type: number

The latitude coordinate of the device in the WGS84 coordinate system

 - + - - + + - +
@@ -2544,12 +2544,12 @@

longType: number

The longitude coordinate of the device in the WGS84 coordinate system

 - + - - + + - + @@ -2599,12 +2599,12 @@

alt_mType: number

The altitude coordinate of the device in meters

 - + - - + + - + @@ -2648,12 +2648,12 @@

serial_noType: string

The serial number of the physical device

 - + - - + + -
+
Examples:

"A1B2C3D4"
@@ -2692,17 +2692,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - hardware

Type: object
+ hardware

SystemHardware

Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties - + - - + + - +
@@ -2741,12 +2741,12 @@

make

Type: string

The manufacturer of the device

 - + - - + + -
+
Example:

"Google"
@@ -2793,12 +2793,12 @@

model

Type: string

The model of the device

 - + - - + + -
+
Examples:

"Pixel 5"
@@ -2849,12 +2849,12 @@

sku

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations

 - + - - + + -
+
Examples:

"GF5KQ"
@@ -2903,12 +2903,12 @@

rev

Type: string

Hardware revision of the device

 - + - - + + -
+
Examples:

"A"
@@ -2956,12 +2956,12 @@

software

Type: object

A collection of items which can be used to describe version of software running on a device

 No Additional Properties - + - - + + -
+
Examples:

"firmware"
@@ -2985,7 +2985,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -3012,12 +3012,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -3057,12 +3057,12 @@

physical_tagType: object

Information used to print a physical QR code label.

 No Additional Properties - + - - + + - +
@@ -3100,12 +3100,12 @@

asset

Type: object
No Additional Properties - + - - + + - +
@@ -3150,12 +3150,12 @@

guid

Type: string
Must match regular expression: ^[a-z]+://[-0-9a-zA-Z_$]+$ - + - - + + - +
@@ -3204,12 +3204,12 @@

site

Type: string
Must match regular expression: ^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$ - + - - + + - + @@ -3258,12 +3258,12 @@

nameType: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - + @@ -3306,12 +3306,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -3327,7 +3327,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -3354,12 +3354,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -3399,12 +3399,12 @@

min_loglevelType: integer Default: 300

The minimum loglevel for reporting log messages below which log entries should not be sent. Default to 300.

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800

+ +

Value must be greater or equal to 100 and lesser or equal to 800

- + @@ -3440,12 +3440,12 @@

metrics_rate_secType: integer

The rate at which the system should send system event updates. 0 indicates no updates.

 - + - -

Value must be greater or equal to 0 and lesser or equal to 86400

+ +

Value must be greater or equal to 0 and lesser or equal to 86400

- + @@ -3475,17 +3475,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -3517,12 +3517,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -3559,17 +3559,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -3608,12 +3608,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -3659,12 +3659,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -3680,7 +3680,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -3714,12 +3714,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -3766,12 +3766,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -3814,12 +3814,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -3861,12 +3861,12 @@

familyType: string
- + - - + + - + @@ -3906,12 +3906,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -3939,12 +3939,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -3982,17 +3982,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discoveryType: object
+ discovery

Discovery Model

Type: object

Discovery target parameters

 No Additional Properties - + - - + + - +
@@ -4023,18 +4023,18 @@

families

Type: object
- + - - + + - +

+ aria-expanded="" aria-controls="discovery_families_pattern1" onclick="setAnchor('#discovery_families_pattern1')">Family Discovery Model Pattern Property

@@ -4044,7 +4044,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -4069,16 +4069,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_discovery_family.json#

Type: object
+ Family Discovery Model

Family Discovery Model

Type: object
No Additional Properties - + - - + + - +
@@ -4121,15 +4121,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generation
Type: stringFormat: date-time

Generational marker for controlling discovery

 - + - - + + -
+
Example:

"2018-08-26T21:00:13Z"
@@ -4183,12 +4183,12 @@

scan_interval_sec

Type: integer

Period, in seconds, for automatic scanning

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- +
@@ -4238,12 +4238,12 @@

scan_duration_sec

Type: integer

Scan duration, in seconds

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -4281,17 +4281,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - localnetType: object
+ localnet

Localnet Model

Type: object

Used to describe device local network parameters

 No Additional Properties - + - - + + - +
@@ -4323,12 +4323,12 @@

parent

Type: object

Parent device to which the device is physically connected

 No Additional Properties - + - - + + - +
@@ -4367,12 +4367,12 @@

target

Type: string

ID of the parent device to which the device is physically connected

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Examples:

"DDC-1"
@@ -4421,12 +4421,12 @@

family

Type: string

Connection family/protocol of the parent device to which the device is physically connected

 - + - - + + -
+
Examples:

"bacnet_mstp"
@@ -4473,12 +4473,12 @@

families

Type: object
No Additional Properties - + - - + + -
+
Examples:

"bacnet"
@@ -4500,7 +4500,7 @@

+ aria-expanded="" aria-controls="localnet_families_pattern1" onclick="setAnchor('#localnet_families_pattern1')">Family Localnet Model Pattern Property

@@ -4510,7 +4510,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z0-9-]+$
@@ -4535,17 +4535,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_localnet_family.json

Type: object
+ Family Localnet Model

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -4591,12 +4591,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -4649,12 +4649,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -4670,7 +4670,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -4711,12 +4711,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -4770,12 +4770,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -4825,12 +4825,12 @@

parent_id

Type: string

The device id of the network parent

 - + - - + + - +
@@ -4879,12 +4879,12 @@

familyType: string
- + - - + + - + @@ -4922,17 +4922,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - testingType: object
+ testing

Testing Model

Type: object

Testing target parameters

 No Additional Properties - + - - + + - +
@@ -4963,12 +4963,12 @@

nostate

Type: boolean
- + - - + + - +
@@ -5003,18 +5003,18 @@

targetsType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="testing_targets_pattern1" onclick="setAnchor('#testing_targets_pattern1')">Target Testing Model Pattern Property

@@ -5024,7 +5024,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -5049,16 +5049,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_testing_target.json#

Type: object
+ Target Testing Model

Target Testing Model

Type: object
No Additional Properties - + - - + + - +
@@ -5104,12 +5104,12 @@

target_point

Type: string

Point name used for testing

 - + - - + + - +
@@ -5159,12 +5159,12 @@

target_valueType: object

Value used for testing

 - + - - + + - + @@ -5202,23 +5202,23 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - featuresType: object
+ features

Testing Model

Type: object

Model of supported features

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="features_pattern1" onclick="setAnchor('#features_pattern1')">Feature Discovery Pattern Property

@@ -5228,7 +5228,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[._a-zA-Z]+$
@@ -5246,17 +5246,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_feature.json

Type: object
+ Feature Discovery

Feature Discovery

Type: object

Object representation for for a single feature

 No Additional Properties - + - - + + - +
@@ -5292,20 +5292,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
- +

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ - - + + - +
@@ -5339,17 +5339,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - pointsetType: object
+ pointset

Pointset Model

Type: object

Pointset representing the abstract system expectation for what the device should be doing, and how it should be configured and operated. This block specifies the expected points that a device holds

 No Additional Properties - + - - + + - +
@@ -5381,18 +5381,18 @@

points

Type: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1" onclick="setAnchor('#pointset_points_pattern1')">Point Pointset Model Pattern Property

@@ -5402,7 +5402,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -5427,17 +5427,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_pointset_point.json#

Type: object
+ Point Pointset Model

Point Pointset Model

Type: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +
@@ -5483,12 +5483,12 @@

units

Type: string

Expected unit configuration for the point

 - + - - + + - +
@@ -5538,12 +5538,12 @@

description

Type: string

Detailed description of this point

 - + - - + + - +
@@ -5593,12 +5593,12 @@

writableType: boolean

Indicates if this point is writable (else read-only)

 - + - - + + - + @@ -5648,12 +5648,12 @@

baseline_valueType: object

Represents the expected baseline value of the point

 - + - - + + -
+
Example:

22
@@ -5707,12 +5707,12 @@

baseline_tolerance

Type: number

Maximum deviation from baseline_value

 - + - - + + -
+
Example:

2
@@ -5766,15 +5766,15 @@

baseline_state

Type: enum (of string)

Expected state when baseline_value is set as the set_value for this point the config message

-

Must be one of:

-
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- +

Must be one of:

+ + + - - + + - + @@ -5824,12 +5824,12 @@

range_minType: number

Represents the lower bound of the error threshold for a point

 - + - - + + -
+
Example:

0
@@ -5883,12 +5883,12 @@

range_max

Type: number

Represents the upper bound of the error threshold for a point

 - + - - + + -
+
Example:

100
@@ -5942,12 +5942,12 @@

cov_increment

Type: number

Triggering threshold for partial cov update publishing

 - + - - + + -
+
Example:

1
@@ -6001,12 +6001,12 @@

ref

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)

 - + - - + + -
+
Examples:

"AI3"
@@ -6061,12 +6061,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -6082,7 +6082,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -6123,12 +6123,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -6182,12 +6182,12 @@

tagsType: array

Tags assosciated with the point

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -6229,12 +6229,12 @@

tags items

Type: object
Must match regular expression: ^[a-z0-9]+$ - + - - + + - +

Examples:
@@ -6297,18 +6297,18 @@

structureType: object

Collection of family point information

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1_structure_pattern1" onclick="setAnchor('#pointset_points_pattern1_structure_pattern1')">Ref Discovery Pattern Property

@@ -6318,7 +6318,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -6357,17 +6357,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -6427,12 +6427,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -6496,12 +6496,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -6565,12 +6565,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -6626,12 +6626,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -6697,12 +6697,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -6766,12 +6766,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -6835,12 +6835,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -6904,12 +6904,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -6973,12 +6973,12 @@

descriptionType: string

Human-readable description of this point

 - + - - + + - + @@ -7039,16 +7039,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -7115,12 +7115,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -7195,12 +7195,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -7268,7 +7268,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -7528,12 +7528,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -7603,12 +7603,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -7678,12 +7678,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -7753,12 +7753,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -7828,12 +7828,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -7903,12 +7903,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -7978,12 +7978,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -8053,12 +8053,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -8128,12 +8128,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -8203,12 +8203,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -8278,12 +8278,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -8353,12 +8353,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -8428,12 +8428,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -8503,12 +8503,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -8578,12 +8578,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -8653,12 +8653,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -8728,12 +8728,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -8803,12 +8803,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -8878,12 +8878,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -8953,12 +8953,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -9028,12 +9028,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -9103,12 +9103,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -9178,12 +9178,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -9253,12 +9253,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -9328,12 +9328,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -9403,12 +9403,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -9478,12 +9478,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -9553,12 +9553,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -9628,12 +9628,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -9703,12 +9703,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -9778,12 +9778,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -9853,12 +9853,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -9928,12 +9928,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -10003,12 +10003,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -10078,12 +10078,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -10153,12 +10153,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -10228,19 +10228,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -10308,15 +10308,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -10391,12 +10391,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -10465,17 +10465,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -10538,12 +10538,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -10559,7 +10559,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -10614,12 +10614,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -10686,12 +10686,12 @@

structureType: object
- + - - + + - +
@@ -10755,17 +10755,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -10839,12 +10839,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -10922,12 +10922,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -11002,18 +11002,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1_structure_pattern1_structure_families_pattern1" onclick="setAnchor('#pointset_points_pattern1_structure_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -11023,7 +11023,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -11083,17 +11083,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -11174,12 +11174,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -11264,12 +11264,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -11332,12 +11332,12 @@

exclude_units_from_configType: boolean
- + - - + + - + @@ -11372,12 +11372,12 @@

exclude_points_from_configType: boolean
- + - - + + - + @@ -11413,12 +11413,12 @@

sample_limit_secType: integer

Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.

 - + - -

Value must be greater or equal to 0 and lesser or equal to 86400

+ +

Value must be greater or equal to 0 and lesser or equal to 86400

- + @@ -11454,12 +11454,12 @@

sample_rate_secType: integer

Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 600.

 - + - -

Value must be greater or equal to 1 and lesser or equal to 86400

+ +

Value must be greater or equal to 1 and lesser or equal to 86400

- + @@ -11491,18 +11491,18 @@

structureType: object
- + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1" onclick="setAnchor('#structure_pattern1')">Discovery Events Pattern Property

@@ -11512,7 +11512,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -11530,17 +11530,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - events_discovery.json

Type: object
+ Discovery Events

Discovery Events

Type: object

Discovery result with implicit discovery

 No Additional Properties - + - - + + - +
@@ -11576,15 +11576,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the discover telemetry event was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -11631,12 +11631,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -11676,15 +11676,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The event's discovery scan trigger's generation timestamp

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -11728,16 +11728,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -11783,12 +11783,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -11842,12 +11842,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -11894,7 +11894,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -12133,12 +12133,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -12187,12 +12187,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -12241,12 +12241,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -12295,12 +12295,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -12349,12 +12349,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -12403,12 +12403,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -12457,12 +12457,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -12511,12 +12511,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -12565,12 +12565,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -12619,12 +12619,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -12673,12 +12673,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -12727,12 +12727,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -12781,12 +12781,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -12835,12 +12835,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -12889,12 +12889,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -12943,12 +12943,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -12997,12 +12997,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -13051,12 +13051,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -13105,12 +13105,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -13159,12 +13159,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -13213,12 +13213,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -13267,12 +13267,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -13321,12 +13321,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -13375,12 +13375,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -13429,12 +13429,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -13483,12 +13483,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -13537,12 +13537,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -13591,12 +13591,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -13645,12 +13645,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -13699,12 +13699,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -13753,12 +13753,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -13807,12 +13807,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -13861,12 +13861,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -13915,12 +13915,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -13969,12 +13969,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -14023,12 +14023,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -14077,19 +14077,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -14136,15 +14136,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -14198,12 +14198,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -14253,12 +14253,12 @@

family

Type: object
- + - - + + - + @@ -14301,12 +14301,12 @@

addrType: string

The primary address of the device (for indicated family)

 - + - - + + - + @@ -14349,12 +14349,12 @@

event_noType: integer

The active or passive series number of this result (matches reported state values)

 - + - - + + - + @@ -14397,18 +14397,18 @@

familiesType: object

Links to other address families (family and id)

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_families_pattern1" onclick="setAnchor('#structure_pattern1_families_pattern1')">Family Discovery Pattern Property

@@ -14418,7 +14418,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -14450,17 +14450,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -14513,12 +14513,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -14575,12 +14575,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -14631,18 +14631,18 @@

registriesType: object

Registry iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_registries_pattern1" onclick="setAnchor('#structure_pattern1_registries_pattern1')">Cloud Model Pattern Property

@@ -14652,7 +14652,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -14684,17 +14684,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -14747,12 +14747,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -14809,15 +14809,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -14874,15 +14874,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -14939,12 +14939,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -15001,15 +15001,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -15063,17 +15063,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -15133,12 +15133,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -15203,17 +15203,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -15280,12 +15280,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -15359,12 +15359,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -15380,7 +15380,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -15442,12 +15442,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -15522,12 +15522,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -15598,12 +15598,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -15673,12 +15673,12 @@

familyType: string
- + - - + + - + @@ -15746,12 +15746,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -15807,12 +15807,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -15878,17 +15878,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -15948,12 +15948,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -16013,12 +16013,12 @@

blockedType: boolean
- + - - + + - + @@ -16074,12 +16074,12 @@

detailType: string
- + - - + + - + @@ -16133,14 +16133,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -16194,14 +16194,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -16255,14 +16255,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -16316,14 +16316,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -16379,12 +16379,12 @@

num_idType: string
- + - - + + - + @@ -16440,15 +16440,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -16505,12 +16505,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -16567,12 +16567,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -16588,7 +16588,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -16636,12 +16636,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -16696,18 +16696,18 @@

devicesType: object

Device iot cloud models

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_devices_pattern1" onclick="setAnchor('#structure_pattern1_devices_pattern1')">Cloud Model Pattern Property

@@ -16717,7 +16717,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -16749,17 +16749,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_cloud.json

Type: object
+ Cloud Model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -16812,12 +16812,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -16874,15 +16874,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -16939,15 +16939,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -17004,12 +17004,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -17066,15 +17066,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -17128,17 +17128,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -17198,12 +17198,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -17268,17 +17268,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -17345,12 +17345,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -17424,12 +17424,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -17445,7 +17445,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -17507,12 +17507,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -17587,12 +17587,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -17663,12 +17663,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -17738,12 +17738,12 @@

familyType: string
- + - - + + - + @@ -17811,12 +17811,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -17872,12 +17872,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -17943,17 +17943,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -18013,12 +18013,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -18078,12 +18078,12 @@

blockedType: boolean
- + - - + + - + @@ -18139,12 +18139,12 @@

detailType: string
- + - - + + - + @@ -18198,14 +18198,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -18259,14 +18259,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -18320,14 +18320,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -18381,14 +18381,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -18444,12 +18444,12 @@

num_idType: string
- + - - + + - + @@ -18505,15 +18505,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -18570,12 +18570,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -18632,12 +18632,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -18653,7 +18653,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -18701,12 +18701,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -18761,18 +18761,18 @@

pointsType: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_points_pattern1" onclick="setAnchor('#structure_pattern1_points_pattern1')">Point Pointset Model Pattern Property

@@ -18782,7 +18782,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -18814,17 +18814,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - model_pointset_point.json#

Type: object
+ Point Pointset Model

Point Pointset Model

Type: object

Information about a specific point name of the device.

 No Additional Properties - + - - + + - +
@@ -18877,12 +18877,12 @@

units

Type: string

Expected unit configuration for the point

 - + - - + + - +
@@ -18939,12 +18939,12 @@

descriptionType: string

Detailed description of this point

 - + - - + + - + @@ -19001,12 +19001,12 @@

writableType: boolean

Indicates if this point is writable (else read-only)

 - + - - + + - + @@ -19063,12 +19063,12 @@

baseline_valueType: object

Represents the expected baseline value of the point

 - + - - + + -
+
Example:

22
@@ -19129,12 +19129,12 @@

baseline_tolerance

Type: number

Maximum deviation from baseline_value

 - + - - + + -
+
Example:

2
@@ -19195,15 +19195,15 @@

baseline_state

Type: enum (of string)

Expected state when baseline_value is set as the set_value for this point the config message

-

Must be one of:

-
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- +

Must be one of:

+ + + - - + + - + @@ -19260,12 +19260,12 @@

range_minType: number

Represents the lower bound of the error threshold for a point

 - + - - + + -
+
Example:

0
@@ -19326,12 +19326,12 @@

range_max

Type: number

Represents the upper bound of the error threshold for a point

 - + - - + + -
+
Example:

100
@@ -19392,12 +19392,12 @@

cov_increment

Type: number

Triggering threshold for partial cov update publishing

 - + - - + + -
+
Example:

1
@@ -19458,12 +19458,12 @@

ref

Type: string

Mapping for the point to an internal resource (e.g. BACnet object reference)

 - + - - + + -
+
Examples:

"AI3"
@@ -19525,12 +19525,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -19546,7 +19546,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -19594,12 +19594,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -19660,12 +19660,12 @@

tagsType: array

Tags assosciated with the point

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -19714,12 +19714,12 @@

tags items

Type: object
Must match regular expression: ^[a-z0-9]+$ - + - - + + - +

Examples:
@@ -19789,18 +19789,18 @@

structureType: object

Collection of family point information

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_points_pattern1_structure_pattern1" onclick="setAnchor('#structure_pattern1_points_pattern1_structure_pattern1')">Ref Discovery Pattern Property

@@ -19810,7 +19810,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -19856,17 +19856,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -19933,12 +19933,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -20009,12 +20009,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -20085,12 +20085,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -20153,12 +20153,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -20231,12 +20231,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -20307,12 +20307,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -20383,12 +20383,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -20459,12 +20459,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -20535,12 +20535,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -20608,16 +20608,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -20691,12 +20691,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -20778,12 +20778,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -20858,7 +20858,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -21125,12 +21125,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -21207,12 +21207,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -21289,12 +21289,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -21371,12 +21371,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -21453,12 +21453,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -21535,12 +21535,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -21617,12 +21617,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -21699,12 +21699,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -21781,12 +21781,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -21863,12 +21863,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -21945,12 +21945,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -22027,12 +22027,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -22109,12 +22109,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -22191,12 +22191,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -22273,12 +22273,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -22355,12 +22355,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -22437,12 +22437,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -22519,12 +22519,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -22601,12 +22601,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -22683,12 +22683,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -22765,12 +22765,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -22847,12 +22847,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -22929,12 +22929,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -23011,12 +23011,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -23093,12 +23093,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -23175,12 +23175,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -23257,12 +23257,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -23339,12 +23339,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -23421,12 +23421,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -23503,12 +23503,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -23585,12 +23585,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -23667,12 +23667,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -23749,12 +23749,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -23831,12 +23831,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -23913,12 +23913,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -23995,12 +23995,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -24077,19 +24077,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -24164,15 +24164,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -24254,12 +24254,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -24335,17 +24335,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -24415,12 +24415,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -24436,7 +24436,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -24498,12 +24498,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -24577,12 +24577,12 @@

structureType: object
- + - - + + - +
@@ -24653,17 +24653,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -24744,12 +24744,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -24834,12 +24834,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -24921,18 +24921,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_points_pattern1_structure_pattern1_structure_families_pattern1" onclick="setAnchor('#structure_pattern1_points_pattern1_structure_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -24942,7 +24942,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -25009,17 +25009,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -25107,12 +25107,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -25204,12 +25204,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -25280,18 +25280,18 @@

refsType: object

Collection of point references

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_refs_pattern1" onclick="setAnchor('#structure_pattern1_refs_pattern1')">Ref Discovery Pattern Property

@@ -25301,7 +25301,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-_.:/a-zA-Z0-9]+$
@@ -25333,17 +25333,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_ref.json#

Type: object
+ Ref Discovery

Ref Discovery

Type: object

Object representation for for a single point reference discovery

 No Additional Properties - + - - + + - +
@@ -25396,12 +25396,12 @@

point

Type: string

Point descriptor for this point

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - + - - + + - +
@@ -25458,12 +25458,12 @@

nameType: string

Friendly name for the reference, if known

 - + - - + + - + @@ -25520,12 +25520,12 @@

possible_valuesType: array of string

List of possible enumerated values for the point

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -25574,12 +25574,12 @@

Each item of this array must be:

possible_values items
Type: string
- + - - + + - +
@@ -25638,12 +25638,12 @@

unitsType: string

Current or default unit for this point

 - + - - + + - + @@ -25700,12 +25700,12 @@

refType: string

Family reference for structures

 - + - - + + - + @@ -25762,12 +25762,12 @@

typeType: string

Current or default type for this point

 - + - - + + - + @@ -25824,12 +25824,12 @@

writableType: boolean

Indicates if this point is writable or not

 - + - - + + - + @@ -25886,12 +25886,12 @@

descriptionType: string

Human-readable description of this point

 - - - - + - + + + + @@ -25945,16 +25945,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -26014,12 +26014,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -26087,12 +26087,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -26153,7 +26153,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -26406,12 +26406,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -26474,12 +26474,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -26542,12 +26542,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -26610,12 +26610,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -26678,12 +26678,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -26746,12 +26746,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -26814,12 +26814,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -26882,12 +26882,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -26950,12 +26950,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -27018,12 +27018,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -27086,12 +27086,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -27154,12 +27154,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -27222,12 +27222,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -27290,12 +27290,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -27358,12 +27358,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -27426,12 +27426,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -27494,12 +27494,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -27562,12 +27562,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -27630,12 +27630,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -27698,12 +27698,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -27766,12 +27766,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -27834,12 +27834,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -27902,12 +27902,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -27970,12 +27970,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -28038,12 +28038,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -28106,12 +28106,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -28174,12 +28174,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -28242,12 +28242,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -28310,12 +28310,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - - - - + - + + + +
@@ -28378,12 +28378,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -28446,12 +28446,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -28514,12 +28514,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -28582,12 +28582,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -28650,12 +28650,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -28718,12 +28718,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -28786,12 +28786,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -28854,19 +28854,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -28927,15 +28927,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -29003,12 +29003,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -29070,17 +29070,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillary

Type: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -29136,12 +29136,12 @@

adjunctType: object
No Additional Properties - + - - + + - +
@@ -29157,7 +29157,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -29205,12 +29205,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -29270,12 +29270,12 @@

structureType: object
- + - - + + - +
@@ -29332,17 +29332,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - point

Type: object
+ point

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -29409,12 +29409,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -29485,12 +29485,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -29558,18 +29558,18 @@

familiesType: object

Reference links to alternate families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_refs_pattern1_structure_families_pattern1" onclick="setAnchor('#structure_pattern1_refs_pattern1_structure_families_pattern1')">Family Discovery Pattern Property

@@ -29579,7 +29579,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -29632,17 +29632,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_family.json

Type: object
+ Family Discovery

Family Discovery

Type: object

Discovery information for a protocol family.

 No Additional Properties - + - - + + - +
@@ -29716,12 +29716,12 @@

addr

Type: string

Device addr in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - +
@@ -29799,12 +29799,12 @@

refType: string

Point reference in the namespace of the given family

Must match regular expression: ^[-_.:0-9A-Z]+$ - + - - + + - + @@ -29867,18 +29867,18 @@

featuresType: object

Discovery of features supported by this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="structure_pattern1_features_pattern1" onclick="setAnchor('#structure_pattern1_features_pattern1')">Feature Discovery Pattern Property

@@ -29888,7 +29888,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[._a-zA-Z]+$
@@ -29920,17 +29920,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery_feature.json

Type: object
+ Feature Discovery

Feature Discovery

Type: object

Object representation for for a single feature

 No Additional Properties - + - - + + - +
@@ -29980,20 +29980,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
- +

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ - - + + - +
@@ -30041,17 +30041,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - cloud_modelType: object
+ cloud_model

Cloud Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -30097,12 +30097,12 @@

functions_ver

Type: integer

Function version of this request

 - + - - + + - +
@@ -30152,15 +30152,15 @@

connection_typeType: enum (of string)

Connection type for connecting to cloud

-

Must be one of:

-
  • "GATEWAY"
  • "DIRECT"
  • "PROXIED"
-
- +

Must be one of:

+ + + - - + + - + @@ -30210,15 +30210,15 @@

auth_typeType: enum (of string)

The key type used for cloud communication.

-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
- +

Must be one of:

+ + + - - + + - + @@ -30268,12 +30268,12 @@

device_keyType: boolean

Indicates if the device private key is provided in the site model.

 - + - - + + - + @@ -30323,15 +30323,15 @@

resource_typeType: enum (of string)

The resource type of this model

-

Must be one of:

-
  • "DEVICE"
  • "GATEWAY"
  • "REGISTRY"
-
- +

Must be one of:

+ + + - - + + - + @@ -30378,17 +30378,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gatewayType: object
+ gateway

Gateway Model

Type: object

Gateway Documentation

 No Additional Properties - - - - + - + + + +
@@ -30441,12 +30441,12 @@

gateway_id

Type: string

The device ID of the gateway the device is bound to

Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + -
+
Example:

"GAT-100"
@@ -30504,17 +30504,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - target

Type: object
+ target

Family Localnet Model

Type: object

The type of network

 No Additional Properties - + - - + + - +
@@ -30574,12 +30574,12 @@

addr

Type: string

The address of a device on the fieldbus/local network

 - + - - + + -
+
Example:

"0x414889"
@@ -30646,12 +30646,12 @@

adjunct

Type: object
No Additional Properties - + - - + + - +
@@ -30667,7 +30667,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -30722,12 +30722,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -30795,12 +30795,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

 - + - - + + - +
@@ -30864,12 +30864,12 @@

parent_idType: string

The device id of the network parent

 - + - - + + - + @@ -30932,12 +30932,12 @@

familyType: string
- + - - + + - + @@ -30998,12 +30998,12 @@

proxy_idsType: array of string

An array of all the device IDs which are bound to the device

 - + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -31052,12 +31052,12 @@

Each item of this array must be:

proxy_ids items
Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +

Example:
@@ -31116,17 +31116,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - configType: object
+ config

Cloud Config Model

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -31179,12 +31179,12 @@

static_file

Type: string

Config file to use. Within the config directory in the device's metadata directory

 - + - - + + - +
@@ -31237,12 +31237,12 @@

blockedType: boolean
- + - - + + - + @@ -31291,12 +31291,12 @@

detailType: string
- + - - + + - + @@ -31343,14 +31343,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - updated_timeType: string
+ updated_timeType: stringFormat: date-time
- + - - + + - + @@ -31397,14 +31397,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_state_timeType: string
+ last_state_timeType: stringFormat: date-time
- + - - + + - + @@ -31451,14 +31451,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config_timeType: string
+ last_config_timeType: stringFormat: date-time
- + - - + + - + @@ -31505,14 +31505,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_error_timeType: string
+ last_error_timeType: stringFormat: date-time
- + - - + + - + @@ -31561,12 +31561,12 @@

num_idType: string
- + - - + + - + @@ -31615,15 +31615,15 @@

operationType: enum (of string)
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
- +

Must be one of:

+ + + - - + + - + @@ -31673,12 +31673,12 @@

metadata_strType: string

Strigified version of the metadata object, used for internal backend processing

 - + - - + + - + @@ -31728,12 +31728,12 @@

device_idsType: object

If operating on the entire registry, then this contains results for multiple devices (batched operation).

 - + - - + + - +
@@ -31749,7 +31749,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[-._a-zA-Z0-9]+$
@@ -31790,12 +31790,12 @@

^[-._a-zA-Z0-9]+$

Type: object
- + - - + + - +

@@ -31843,14 +31843,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System Discovery Data

Type: object
No Additional Properties - + - - + + - +
@@ -31896,12 +31896,12 @@

description

Type: string

Full textual desctiiption of this device

 - + - - + + - +
@@ -31951,12 +31951,12 @@

nameType: string

Friendly name of this device

 - + - - + + - + @@ -32006,12 +32006,12 @@

serial_noType: string

The serial number of the physical device

 - + - - + + - + @@ -32058,17 +32058,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ancillaryType: object
+ ancillary

Ancillary Properties

Type: object

Arbitrary blob of json associated with this point

 - + - - + + - + @@ -32115,17 +32115,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - hardwareType: object
+ hardware

State System Hardware

Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties - + - - + + - +
@@ -32178,12 +32178,12 @@

make

Type: string

The manufacturer of the device

 - + - - + + -
+
Example:

"Google"
@@ -32244,12 +32244,12 @@

model

Type: string

The model of the device

 - + - - + + -
+
Examples:

"Pixel 5"
@@ -32314,12 +32314,12 @@

sku

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations

 - + - - + + -
+
Examples:

"GF5KQ"
@@ -32382,12 +32382,12 @@

rev

Type: string

Hardware revision of the device

 - + - - + + -
+
Examples:

"A"
diff --git a/gencode/docs/monitoring.html b/gencode/docs/monitoring.html index f3dd4ba75d..f6e8578133 100644 --- a/gencode/docs/monitoring.html +++ b/gencode/docs/monitoring.html @@ -15,20 +15,20 @@ Monitoring -

Monitoring

+
-
Type: object
+

Monitoring

Type: object

Output from UDMIS monitoring

 - + - - + + - +
@@ -50,17 +50,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - metric

Type: object
+ metric

Monitoring metric

Type: object

One metric

 No Additional Properties - + - - + + - +
@@ -89,17 +89,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - system

Type: object
+ system

System Events

Type: object

Used for system events such as logging. System Event Documentation

 No Additional Properties - + - - + + - +
@@ -135,15 +135,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC timestamp the event payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -190,12 +190,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -238,12 +238,12 @@

upgraded_from

Type: string

Original version of schema pre-upgrade

 - + - - + + - +
@@ -283,15 +283,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_configType: string
+ last_configType: stringFormat: date-time

Last config received

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -337,12 +337,12 @@

logentries

Type: array
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -375,16 +375,16 @@

Each item of this array must be:

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - entry.json
Type: object
+ Entry

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -437,12 +437,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -503,12 +503,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -562,7 +562,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -808,12 +808,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -869,12 +869,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -930,12 +930,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -991,12 +991,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -1052,12 +1052,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -1113,12 +1113,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1174,12 +1174,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1235,12 +1235,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1296,12 +1296,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1357,12 +1357,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1418,12 +1418,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1479,12 +1479,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1540,12 +1540,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1601,12 +1601,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1662,12 +1662,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1723,12 +1723,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1784,12 +1784,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1845,12 +1845,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1906,12 +1906,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1967,12 +1967,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -2028,12 +2028,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -2089,12 +2089,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -2150,12 +2150,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -2211,12 +2211,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -2272,12 +2272,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2333,12 +2333,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2394,12 +2394,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2455,12 +2455,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2516,12 +2516,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2577,12 +2577,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2638,12 +2638,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2699,12 +2699,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2760,12 +2760,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2821,12 +2821,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2882,12 +2882,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2943,12 +2943,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -3004,19 +3004,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -3070,15 +3070,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -3139,12 +3139,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -3197,12 +3197,12 @@

event_no

Type: integer

Sequence number for this event

 - + - - + + - + @@ -3244,12 +3244,12 @@

metricsType: object
No Additional Properties - + - - + + - +
@@ -3294,12 +3294,12 @@

mem_total_mb

Type: number
- + - - + + - +
@@ -3348,12 +3348,12 @@

mem_free_mbType: number
- + - - + + - + @@ -3402,12 +3402,12 @@

store_total_mbType: number
- + - - + + - + @@ -3456,12 +3456,12 @@

store_free_mbType: number
- + - - + + - + @@ -3510,12 +3510,12 @@

system_loadType: number
- + - - + + - + @@ -3556,17 +3556,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - envelopeType: object
+ envelope

Envelope

Type: object

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

 - + - - + + - +
@@ -3604,12 +3604,12 @@

deviceId

Type: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - +
@@ -3651,12 +3651,12 @@

deviceNumIdType: string
Must match regular expression: ^[0-9]+$ - + - - + + - + @@ -3698,12 +3698,12 @@

deviceRegistryIdType: string
Must match regular expression: ^[a-zA-Z][-a-zA-Z0-9._+~%]*[a-zA-Z0-9]$ - + - - + + - + @@ -3745,12 +3745,12 @@

deviceRegistryLocationType: string
Must match regular expression: ^[a-z]+-[a-z]+1$ - + - - + + - + @@ -3792,12 +3792,12 @@

projectIdType: string
Must match regular expression: ^([.a-z]+:)?[a-z][-a-z0-9]*[a-z0-9]$ - + - - + + - + @@ -3839,12 +3839,12 @@

payloadType: string
- + - - + + - + @@ -3886,12 +3886,12 @@

sourceType: string
- + - - + + - + @@ -3933,12 +3933,12 @@

gatewayIdType: string
Must match regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$ - + - - + + - + @@ -3980,12 +3980,12 @@

transactionIdType: string
- + - - + + - + @@ -4025,14 +4025,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - publishTimeType: string
+ publishTimeType: stringFormat: date-time
- + - - + + - + @@ -4074,12 +4074,12 @@

rawFolderType: string
- + - - + + - + @@ -4121,15 +4121,15 @@

subFolderType: enum (of string)
-

Must be one of:

-
  • "udmi"
  • "update"
  • "invalid"
  • "error"
  • "cloud"
  • "discovery"
  • "mapping"
  • "system"
  • "gateway"
  • "swarm"
  • "localnet"
  • "pointset"
  • "validation"
  • "blobset"
  • "monitoring"
-
- +

Must be one of:

+ + + - - + + - + @@ -4171,15 +4171,15 @@

subTypeType: enum (of string)
-

Must be one of:

-
  • "invalid"
  • "reflect"
  • "events"
  • "errors"
  • "commands"
  • "config"
  • "state"
  • "query"
  • "reply"
  • "model"
-
- +

Must be one of:

+ + + - - + + - + @@ -4221,12 +4221,12 @@

additionalPropertiesType: object
- + - - + + - + diff --git a/gencode/docs/persistent_device.html b/gencode/docs/persistent_device.html index c4f60797cb..15d4d7f913 100644 --- a/gencode/docs/persistent_device.html +++ b/gencode/docs/persistent_device.html @@ -15,20 +15,20 @@ Device Persistent -

Device Persistent

+
-
Type: object
+

Device Persistent

Type: object

Device persistent data

 - + - - + + - +
@@ -50,17 +50,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - endpoint

Type: object
+ endpoint

Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties - + - - + + - +
@@ -92,12 +92,12 @@

name

Type: string

Friendly name for this flow (debugging and diagnostics)

 - + - - + + - +
@@ -132,15 +132,15 @@

protocol

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -175,15 +175,15 @@

transportType: enum (of string)
-

Must be one of:

-
  • "ssl"
  • "tcp"
-
- +

Must be one of:

+ + + - - + + - + @@ -218,12 +218,12 @@

hostnameType: string
- + - - + + - + @@ -259,12 +259,12 @@

payloadType: string

Simple payload template for simple injection use cases

 - + - - + + - + @@ -300,12 +300,12 @@

errorType: string

Error message container for capturing errors during parsing/handling

 - + - - + + - + @@ -340,12 +340,12 @@

portType: integer
- + - - + + - + @@ -381,12 +381,12 @@

config_sync_secType: integer

Delay waiting for config message on start, 0 for default, <0 to disable

 - + - - + + - + @@ -421,12 +421,12 @@

client_idType: string
- + - - + + - + @@ -462,12 +462,12 @@

topic_prefixType: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$ - + - - + + - + @@ -503,12 +503,12 @@

recv_idType: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -544,12 +544,12 @@

send_idType: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -585,12 +585,12 @@

side_idType: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$ - + - - + + - + @@ -625,12 +625,12 @@

gatewayIdType: string
- + - - + + - + @@ -665,12 +665,12 @@

deviceIdType: string
- + - - + + - + @@ -706,12 +706,12 @@

enabledType: string

Indicator if this endpoint should be active (null or non-empty)

 - + - - + + - + @@ -747,12 +747,12 @@

noConfigAckType: boolean

True if config messages should not be acked (lower QOS)

 - + - - + + - + @@ -788,12 +788,12 @@

capacityType: integer

Queue capacity for limiting pipes

 - + - - + + - + @@ -829,12 +829,12 @@

publish_delay_secType: integer

Artifical publish delay for testing

 - + - - + + - + @@ -870,12 +870,12 @@

periodic_secType: integer

Rate for periodic task execution

 - + - - + + - + @@ -910,12 +910,12 @@

keyBytesType: object
- + - - + + - + @@ -950,12 +950,12 @@

algorithmType: string
- + - - + + - + @@ -990,12 +990,12 @@

auth_providerType: object
No Additional Properties - + - - + + - +
@@ -1033,12 +1033,12 @@

basic

Type: object
No Additional Properties - + - - + + - +
@@ -1083,12 +1083,12 @@

username

Type: string
- + - - + + - +
@@ -1137,12 +1137,12 @@

password

Type: string
- + - - + + - + @@ -1188,12 +1188,12 @@

jwtType: object
No Additional Properties - + - - + + - +
@@ -1238,12 +1238,12 @@

audience

Type: string
- + - - + + - +
@@ -1284,15 +1284,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

The timestamp of the endpoint generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -1328,12 +1328,12 @@

restart_count

Type: integer
- + - - + + - + @@ -1361,12 +1361,12 @@

additionalPropertiesType: object
- + - - + + - + diff --git a/gencode/docs/properties.html b/gencode/docs/properties.html index 4d98cc3f95..22e74f184a 100644 --- a/gencode/docs/properties.html +++ b/gencode/docs/properties.html @@ -15,19 +15,19 @@ Properties -

Properties

+
-
Type: object
+

Properties

Type: object
No Additional Properties - + - - + + - +
@@ -51,15 +51,15 @@

key_type

Type: enum (of string)
-

Must be one of:

-
  • "RSA_PEM"
  • "RSA_X509_PEM"
-
- +

Must be one of:

+
  • "RSA_PEM"
  • "RSA_X509_PEM"
+
+ - - + + - +
@@ -88,12 +88,12 @@

versionType: string

Version of the UDMI schema

 - + - - + + - + @@ -121,15 +121,15 @@

connectType: enum (of string)
-

Must be one of:

-
  • "direct"
-
- +

Must be one of:

+ + + - - + + - + diff --git a/gencode/docs/query_cloud.html b/gencode/docs/query_cloud.html index ed8f281f75..295f22e2f2 100644 --- a/gencode/docs/query_cloud.html +++ b/gencode/docs/query_cloud.html @@ -15,20 +15,20 @@ Cloud Query -

Cloud Query

+
-
Type: object
+

Cloud Query

Type: object

Information specific to how the device communicates with the cloud.

 No Additional Properties - + - - + + - +
@@ -50,14 +50,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time
- + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -90,12 +90,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -121,15 +121,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

generational marker for this query

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -163,15 +163,15 @@

-

Must be one of:

-
  • "buckets"
  • "entries"
  • "details"
  • "parts"
-
- +

Must be one of:

+
  • "buckets"
  • "entries"
  • "details"
  • "parts"
+
+ - - + + - + diff --git a/gencode/docs/schema_doc.css b/gencode/docs/schema_doc.css index 83897d896b..e1f3a5112e 100644 --- a/gencode/docs/schema_doc.css +++ b/gencode/docs/schema_doc.css @@ -7,6 +7,7 @@ body { .btn.btn-link { font-size: 18px; + user-select: text; } .jsfh-animated-property { @@ -177,4 +178,4 @@ body { .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ -.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */ \ No newline at end of file +.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */ diff --git a/gencode/docs/schema_doc.min.js b/gencode/docs/schema_doc.min.js index 0d9c7882d8..17eceaf59a 100644 --- a/gencode/docs/schema_doc.min.js +++ b/gencode/docs/schema_doc.min.js @@ -1 +1 @@ -function flashElement(t){myElement=document.getElementById(t),myElement.classList.add("jsfh-animated-property"),setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(t){history.pushState({},"",t)}function anchorOnLoad(){let t=window.location.hash.split("?")[0].split("&")[0];"#"===t[0]&&(t=t.substr(1)),t.length>0&&anchorLink(t)}function anchorLink(t){$("#"+t).parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(t){if($(this).hasClass("collapse"))$(this).collapse("show");else if($(this).hasClass("tab-pane")){const t=$("a[href='#"+$(this).attr("id")+"']");t&&t.tab("show")}else"tab"===$(this).attr("role")&&$(this).tab("show")}),setTimeout(function(){let e=document.getElementById(t);e&&(e.scrollIntoView({block:"center",behavior:"smooth"}),setTimeout(function(){flashElement(t)},500))},1e3)}$(document).on("click",'a[href^="#"]',function(t){t.preventDefault(),history.pushState({},"",this.href)}); \ No newline at end of file +$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file diff --git a/gencode/docs/site_metadata.html b/gencode/docs/site_metadata.html index 0d6dc883c7..44dd323cff 100644 --- a/gencode/docs/site_metadata.html +++ b/gencode/docs/site_metadata.html @@ -15,19 +15,19 @@ Site Metadata -

Site Metadata

+
-
Type: object
+

Site Metadata

Type: object
No Additional Properties - + - - + + - +
@@ -49,15 +49,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 timestamp when the site metadata was last updated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -90,12 +90,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + -
+
Example:

"1.5.0"
@@ -128,12 +128,12 @@

site

Type: string

Identifier for the site or building

Must match regular expression: ^[A-Z]{2}-[A-Z]{3,4}-[A-Z0-9]{2,9}$ - + - - + + -
+
Examples:

"UK-LON-ABC"
@@ -168,12 +168,12 @@

name

Type: string

Name of the site or building

 - + - - + + -
+
Examples:

"Cheesegrater"
@@ -208,12 +208,12 @@

tags

Type: array

Tags associated with the site

 - + - - + + -

All items must be unique

Each item of this array must be:

+

All items must be unique

No Additional Items

Each item of this array must be:

@@ -234,12 +234,12 @@

tags items

Type: object
Must match regular expression: ^[_a-z0-9]+$ - + - - + + - +

Examples:
@@ -281,12 +281,12 @@

strict_warnings

Type: boolean

Enable strict checking and treat warnings as errors

 - + - - + + - + @@ -312,14 +312,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - locationType: object
+ location

Site Location

Type: object
No Additional Properties - + - - + + - +
@@ -351,12 +351,12 @@

address

Type: string

Postal address of the site

 - + - - + + -
+
Examples:

"1600 Amphitheatre Parkway, Mountain View, CA 94043, United States"
@@ -398,12 +398,12 @@

lat

Type: number

Latitude of the site in WGS84 coordinates, North of the equator, as indicated by a map marker

 - + - - + + -
+
Example:

41.8902
@@ -443,12 +443,12 @@

long

Type: number

Longitude of the site in WGS84 coordinates, East of Greenwich, as indicated by a map marker

 - + - - + + -
+
Example:

12.4922
@@ -482,14 +482,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - links

Type: object
+ links

Site Links

Type: object
No Additional Properties - + - - + + - +

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -1172,14 +1172,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -1226,14 +1226,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -1280,14 +1280,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -1334,14 +1334,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -1388,21 +1388,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -1446,17 +1446,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gross_internal_areaType: object
+ gross_internal_area

Dimension

Type: object

Gross internal Area of the site

 No Additional Properties - + - - + + - +
@@ -1501,12 +1501,12 @@

value

Type: number
- + - - + + - +
@@ -1638,14 +1638,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -1692,14 +1692,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -1746,14 +1746,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -1800,14 +1800,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -1854,14 +1854,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -1908,14 +1908,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -1962,21 +1962,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -2019,12 +2019,12 @@

electricityType: object
No Additional Properties - + - - + + - +
@@ -2060,17 +2060,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - carbon_factor

Type: object
+ carbon_factor

Dimension

Type: object

Carbon dioxide factor for electricity consumption

 No Additional Properties - + - - + + - +
@@ -2115,12 +2115,12 @@

value

Type: number
- + - - + + - +
@@ -2252,14 +2252,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -2306,14 +2306,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -2360,14 +2360,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -2414,14 +2414,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -2468,14 +2468,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -2522,14 +2522,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -2576,21 +2576,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -2634,17 +2634,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - unit_costType: object
+ unit_cost

Dimension

Type: object

Unit cost for electricity consumption

 No Additional Properties - + - - + + - +
@@ -2689,12 +2689,12 @@

value

Type: number
- + - - + + - +
@@ -2826,14 +2826,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -2880,14 +2880,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -2934,14 +2934,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -2988,14 +2988,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -3042,14 +3042,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -3096,14 +3096,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -3150,21 +3150,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -3207,12 +3207,12 @@

gasType: object
No Additional Properties - + - - + + - +
@@ -3248,17 +3248,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - carbon_factor

Type: object
+ carbon_factor

Dimension

Type: object

Carbon dioxide factor for gas consumption

 No Additional Properties - + - - + + - +
@@ -3303,12 +3303,12 @@

value

Type: number
- + - - + + - +
@@ -3440,14 +3440,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -3494,14 +3494,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -3548,14 +3548,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -3602,14 +3602,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -3656,14 +3656,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -3710,14 +3710,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -3764,21 +3764,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -3822,17 +3822,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - unit_costType: object
+ unit_cost

Dimension

Type: object

Unit cost for gas consumption

 No Additional Properties - + - - + + - +
@@ -3877,12 +3877,12 @@

value

Type: number
- + - - + + - +
@@ -4014,14 +4014,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -4068,14 +4068,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -4122,14 +4122,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -4176,14 +4176,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -4230,14 +4230,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -4284,14 +4284,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -4338,21 +4338,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + @@ -4395,12 +4395,12 @@

waterType: object
No Additional Properties - + - - + + - +
@@ -4436,17 +4436,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - unit_cost

Type: object
+ unit_cost

Dimension

Type: object

Unit cost for water consumption

 No Additional Properties - + - - + + - +
@@ -4491,12 +4491,12 @@

value

Type: number
- + - - + + - +
@@ -4628,14 +4628,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - m2Type: object
+ m2

m2

Type: object
Must match regular expression: ^m2$ - + - - + + - +
@@ -4682,14 +4682,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - sqf

Type: object
+ sqf

sqf

Type: object
Must match regular expression: ^sqf$ - + - - + + - +
@@ -4736,14 +4736,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - kgCO2e/kWh

Type: object
+ kgCO2e/kWh

kgCO2e/kWh

Type: object
Must match regular expression: ^kgCO2e/kWh - + - - + + - +
@@ -4790,14 +4790,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/m3

Type: object
+ £/m3

£/m3

Type: object
Must match regular expression: ^£/m3$ - + - - + + - +
@@ -4844,14 +4844,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/gal

Type: object
+ $/gal

$/gal

Type: object
Must match regular expression: ^\$/gal - + - - + + - +
@@ -4898,14 +4898,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - £/kWh

Type: object
+ £/kWh

£/kWh

Type: object
Must match regular expression: ^£/kWh$ - + - - + + - +
@@ -4952,21 +4952,21 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - $/kWh

Type: object
+ $/kWh

$/kWh

Type: object
Must match regular expression: ^\$/kWh$ - + - - + + - + - + - - + + - + diff --git a/gencode/docs/state.html b/gencode/docs/state.html index 06030fae65..93f12a4369 100644 --- a/gencode/docs/state.html +++ b/gencode/docs/state.html @@ -15,20 +15,20 @@ State -

State

+
-
Type: object
+

State

Type: object

State message, defined by [state.json]

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

RFC 3339 UTC Timestamp the state payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -122,17 +122,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - systemType: object
+ system

System State

Type: object

System State Documentation

 No Additional Properties - + - - + + - +
@@ -161,15 +161,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_config

Type: string
+ last_config
Type: stringFormat: date-time

Time from the timestamp field of the last successfully parsed config message (not the timestamp the message was received/processed). Part of the config state sequence

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -206,17 +206,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - operation

Type: object
+ operation

StateSystemOperation

Type: object

A collection of state fields that describes the system operation

 No Additional Properties - + - - + + - +
@@ -255,12 +255,12 @@

operational

Type: boolean

Operational status of the device.

 - + - - + + - +
@@ -300,15 +300,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_startType: string
+ last_startType: stringFormat: date-time

Last time the system started up.

 - + - - + + - + @@ -351,12 +351,12 @@

restart_countType: integer

Number of system restarts

 - + - - + + - + @@ -396,20 +396,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - modeType: enum (of string)
+ mode

System Mode

Type: enum (of string)

Operating mode for the device. Default is 'active'.
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -449,12 +449,12 @@

serial_noType: string

The serial number of the physical device

 - + - - + + -
+
Examples:

"A1B2C3D4"
@@ -493,17 +493,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - hardware

Type: object
+ hardware

State System Hardware

Type: object

A collection of fields which describe the physical hardware of the device.

 No Additional Properties - + - - + + - +
@@ -542,12 +542,12 @@

make

Type: string

The manufacturer of the device

 - + - - + + -
+
Example:

"Google"
@@ -594,12 +594,12 @@

model

Type: string

The model of the device

 - + - - + + -
+
Examples:

"Pixel 5"
@@ -650,12 +650,12 @@

sku

Type: string

A stock keeping unit which identifies the unique composition of a device, for example those with different hardware configurations

 - + - - + + -
+
Examples:

"GF5KQ"
@@ -704,12 +704,12 @@

rev

Type: string

Hardware revision of the device

 - + - - + + -
+
Examples:

"A"
@@ -757,12 +757,12 @@

software

Type: object

A collection of items which can be used to describe version of software running on a device

 No Additional Properties - + - - + + -
+
Examples:

"firmware"
@@ -786,7 +786,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -813,12 +813,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -857,12 +857,12 @@

paramsType: object
No Additional Properties - + - - + + - +
@@ -878,7 +878,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z_]+$
@@ -905,12 +905,12 @@

^[a-z_]+$

Type: string
- + - - + + - +

@@ -947,16 +947,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -995,12 +995,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -1047,12 +1047,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -1092,7 +1092,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -1324,12 +1324,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -1371,12 +1371,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -1418,12 +1418,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -1465,12 +1465,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -1512,12 +1512,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -1559,12 +1559,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1606,12 +1606,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1653,12 +1653,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1700,12 +1700,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1747,12 +1747,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1794,12 +1794,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1841,12 +1841,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1888,12 +1888,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1935,12 +1935,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1982,12 +1982,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -2029,12 +2029,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -2076,12 +2076,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -2123,12 +2123,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -2170,12 +2170,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -2217,12 +2217,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -2264,12 +2264,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -2311,12 +2311,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -2358,12 +2358,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -2405,12 +2405,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -2452,12 +2452,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2499,12 +2499,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2546,12 +2546,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2593,12 +2593,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2640,12 +2640,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2687,12 +2687,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2734,12 +2734,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2781,12 +2781,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2828,12 +2828,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2875,12 +2875,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2922,12 +2922,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2969,12 +2969,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -3016,19 +3016,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -3068,15 +3068,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -3123,12 +3123,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -3166,17 +3166,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - gateway

Type: object
+ gateway

Gateway State

Type: object

Gateway Documentation

 No Additional Properties - + - - + + - +
@@ -3205,16 +3205,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -3253,12 +3253,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -3305,12 +3305,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -3350,7 +3350,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -3582,12 +3582,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -3629,12 +3629,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -3676,12 +3676,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -3723,12 +3723,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -3770,12 +3770,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -3817,12 +3817,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -3864,12 +3864,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -3911,12 +3911,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -3958,12 +3958,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -4005,12 +4005,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -4052,12 +4052,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -4099,12 +4099,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -4146,12 +4146,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -4193,12 +4193,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -4240,12 +4240,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -4287,12 +4287,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -4334,12 +4334,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -4381,12 +4381,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -4428,12 +4428,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -4475,12 +4475,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -4522,12 +4522,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -4569,12 +4569,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -4616,12 +4616,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -4663,12 +4663,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -4710,12 +4710,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -4757,12 +4757,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -4804,12 +4804,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -4851,12 +4851,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -4898,12 +4898,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -4945,12 +4945,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -4992,12 +4992,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -5039,12 +5039,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -5086,12 +5086,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -5133,12 +5133,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -5180,12 +5180,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -5227,12 +5227,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -5274,19 +5274,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -5326,15 +5326,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -5381,12 +5381,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -5424,17 +5424,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discovery

Type: object
+ discovery

Discovery State

Type: object

State for discovery

 No Additional Properties - + - - + + - +
@@ -5463,15 +5463,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -5511,12 +5511,12 @@

version

Type: string

Version of the UDMI schema, not included in messages published by devices

 - + - - + + - +
@@ -5549,15 +5549,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generationType: string
+ generationType: stringFormat: date-time

Generational marker to group results together

 - + - - + + - + @@ -5593,18 +5593,18 @@

familiesType: object

Discovery protocol families

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="discovery_families_pattern1" onclick="setAnchor('#discovery_families_pattern1')">Family Discovery State Pattern Property

@@ -5614,7 +5614,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -5639,17 +5639,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_discovery_family.json

Type: object
+ Family Discovery State

Family Discovery State

Type: object

State for discovery

 No Additional Properties - + - - + + - +
@@ -5692,15 +5692,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generation
Type: stringFormat: date-time

Generational marker for reporting discovery

 - + - - + + - +
@@ -5750,15 +5750,15 @@

phaseType: enum (of string)

Current phase of an active discovery process

-

Must be one of:

-
  • "stopped"
  • "pending"
  • "active"
-
- +

Must be one of:

+ + + - - + + - + @@ -5808,12 +5808,12 @@

active_countType: integer

Number of records produced so far for this active scan generation

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -5863,12 +5863,12 @@

passive_countType: integer

Number of passive scan results currently 'on hold'

 - + - -

Value must be greater or equal to 0

+ +

Value must be greater or equal to 0

- + @@ -5915,17 +5915,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object

Status information about the discovery operation

 No Additional Properties - + - - + + - +
@@ -5978,12 +5978,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -6044,12 +6044,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -6103,7 +6103,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -6349,12 +6349,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -6410,12 +6410,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -6471,12 +6471,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -6532,12 +6532,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -6593,12 +6593,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -6654,12 +6654,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -6715,12 +6715,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -6776,12 +6776,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -6837,12 +6837,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -6898,12 +6898,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -6959,12 +6959,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -7020,12 +7020,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -7081,12 +7081,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -7142,12 +7142,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -7203,12 +7203,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -7264,12 +7264,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -7325,12 +7325,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -7386,12 +7386,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -7447,12 +7447,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -7508,12 +7508,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -7569,12 +7569,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -7630,12 +7630,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -7691,12 +7691,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -7752,12 +7752,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -7813,12 +7813,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -7874,12 +7874,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -7935,12 +7935,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -7996,12 +7996,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -8057,12 +8057,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -8118,12 +8118,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -8179,12 +8179,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -8240,12 +8240,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -8301,12 +8301,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -8362,12 +8362,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -8423,12 +8423,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -8484,12 +8484,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -8545,19 +8545,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -8611,15 +8611,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -8680,12 +8680,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -8731,16 +8731,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - localnet

Type: object
+ localnet

Localnet State

Type: object
No Additional Properties - + - - + + - +
@@ -8771,18 +8771,18 @@

families

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="localnet_families_pattern1" onclick="setAnchor('#localnet_families_pattern1')">Family Localnet State Pattern Property

@@ -8792,7 +8792,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^_?[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -8817,16 +8817,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_localnet_family.json

Type: object
+ Family Localnet State

Family Localnet State

Type: object
No Additional Properties - + - - + + - +
@@ -8871,12 +8871,12 @@

addr

Type: string
- + - - + + - +
@@ -8923,16 +8923,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - status

Type: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -8985,12 +8985,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -9051,12 +9051,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -9110,7 +9110,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -9356,12 +9356,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -9417,12 +9417,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -9478,12 +9478,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -9539,12 +9539,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -9600,12 +9600,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -9661,12 +9661,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -9722,12 +9722,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -9783,12 +9783,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -9844,12 +9844,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -9905,12 +9905,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -9966,12 +9966,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -10027,12 +10027,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -10088,12 +10088,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -10149,12 +10149,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -10210,12 +10210,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -10271,12 +10271,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -10332,12 +10332,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -10393,12 +10393,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -10454,12 +10454,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -10515,12 +10515,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -10576,12 +10576,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -10637,12 +10637,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -10698,12 +10698,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -10759,12 +10759,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -10820,12 +10820,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -10881,12 +10881,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -10942,12 +10942,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -11003,12 +11003,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -11064,12 +11064,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -11125,12 +11125,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -11186,12 +11186,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -11247,12 +11247,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -11308,12 +11308,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -11369,12 +11369,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -11430,12 +11430,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -11491,12 +11491,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -11552,19 +11552,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -11618,15 +11618,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -11687,12 +11687,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -11738,16 +11738,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - blobset

Type: object
+ blobset

Blobset State

Type: object
No Additional Properties - + - - + + - +
@@ -11778,18 +11778,18 @@

blobs

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="blobset_blobs_pattern1" onclick="setAnchor('#blobset_blobs_pattern1')">Blob Blobset State Pattern Property

@@ -11799,7 +11799,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^_?[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -11824,16 +11824,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_blobset_blob.json#

Type: object
+ Blob Blobset State

Blob Blobset State

Type: object
No Additional Properties - + - - + + - +
@@ -11876,20 +11876,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - phase

Type: enum (of string)
+ phase

BlobPhase

Type: enum (of string)

Phase for the management of a configuration blob.
-

Must be one of:

-
  • "apply"
  • "final"
-
- +

Must be one of:

+
  • "apply"
  • "final"
+
+ - - + + - +
@@ -11936,16 +11936,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -11998,12 +11998,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -12064,12 +12064,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -12123,7 +12123,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -12369,12 +12369,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -12430,12 +12430,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -12491,12 +12491,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -12552,12 +12552,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -12613,12 +12613,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -12674,12 +12674,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -12735,12 +12735,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -12796,12 +12796,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -12857,12 +12857,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -12918,12 +12918,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -12979,12 +12979,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -13040,12 +13040,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -13101,12 +13101,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -13162,12 +13162,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -13223,12 +13223,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -13284,12 +13284,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -13345,12 +13345,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -13406,12 +13406,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -13467,12 +13467,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -13528,12 +13528,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -13589,12 +13589,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -13650,12 +13650,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -13711,12 +13711,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -13772,12 +13772,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -13833,12 +13833,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -13894,12 +13894,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -13955,12 +13955,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -14016,12 +14016,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -14077,12 +14077,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -14138,12 +14138,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -14199,12 +14199,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -14260,12 +14260,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -14321,12 +14321,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -14382,12 +14382,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -14443,12 +14443,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -14504,12 +14504,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -14565,19 +14565,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -14631,15 +14631,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -14700,12 +14700,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -14760,15 +14760,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - generation

Type: string
+ generationType: stringFormat: date-time

The timestamp of the blob generation

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -14810,17 +14810,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - pointset

Type: object
+ pointset

Pointset State

Type: object

A set of points reporting telemetry data.

 No Additional Properties - + - - + + - +
@@ -14852,12 +14852,12 @@

state_etag

Type: string

An identifier which uniquely represents the state, and used by a device avoid race conditions where the incoming config is based off an obsolete state. Additional information on implementation

 - + - -

Must be at most 32 characters long

+ +

Must be at most 32 characters long

- +
@@ -14890,17 +14890,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object

Optional status information about pointset

 No Additional Properties - + - - + + - +
@@ -14939,12 +14939,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -14991,12 +14991,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -15036,7 +15036,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -15268,12 +15268,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -15315,12 +15315,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -15362,12 +15362,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -15409,12 +15409,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -15456,12 +15456,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -15503,12 +15503,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -15550,12 +15550,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -15597,12 +15597,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -15644,12 +15644,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -15691,12 +15691,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -15738,12 +15738,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -15785,12 +15785,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -15832,12 +15832,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -15879,12 +15879,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -15926,12 +15926,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -15973,12 +15973,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -16020,12 +16020,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -16067,12 +16067,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -16114,12 +16114,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -16161,12 +16161,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -16208,12 +16208,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -16255,12 +16255,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - - - - + - + + + +
@@ -16302,12 +16302,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -16349,12 +16349,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -16396,12 +16396,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -16443,12 +16443,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -16490,12 +16490,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -16537,12 +16537,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -16584,12 +16584,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -16631,12 +16631,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -16678,12 +16678,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -16725,12 +16725,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -16772,12 +16772,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -16819,12 +16819,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -16866,12 +16866,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -16913,12 +16913,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -16960,19 +16960,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -17012,15 +17012,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -17067,12 +17067,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -17116,18 +17116,18 @@

points

Type: object

Collection of point names, defining the representative point set for this device.

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="pointset_points_pattern1" onclick="setAnchor('#pointset_points_pattern1')">Point Pointset State Pattern Property

@@ -17137,7 +17137,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
@@ -17162,17 +17162,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_pointset_point.json#

Type: object
+ Point Pointset State

Point Pointset State

Type: object

Object representation for for a single point

 No Additional Properties - + - - + + - +
@@ -17218,12 +17218,12 @@

units

Type: string

If specified, indicates a programmed point unit. If empty, means unspecified or matches configured point.

 - + - - + + - +
@@ -17273,15 +17273,15 @@

value_stateType: enum (of string)

State of the individual point

-

Must be one of:

-
  • "initializing"
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- +

Must be one of:

+ + + - - + + - + @@ -17328,17 +17328,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object

Optional status information about this point, subject to log severity level

 No Additional Properties - + - - + + - +
@@ -17391,12 +17391,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -17457,12 +17457,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -17516,7 +17516,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -17762,12 +17762,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -17823,12 +17823,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -17884,12 +17884,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -17945,12 +17945,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -18006,12 +18006,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -18067,12 +18067,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -18128,12 +18128,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -18189,12 +18189,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -18250,12 +18250,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -18311,12 +18311,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -18372,12 +18372,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -18433,12 +18433,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -18494,12 +18494,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -18555,12 +18555,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -18616,12 +18616,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -18677,12 +18677,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -18738,12 +18738,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -18799,12 +18799,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -18860,12 +18860,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -18921,12 +18921,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -18982,12 +18982,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -19043,12 +19043,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -19104,12 +19104,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -19165,12 +19165,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -19226,12 +19226,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -19287,12 +19287,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -19348,12 +19348,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -19409,12 +19409,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -19470,12 +19470,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -19531,12 +19531,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -19592,12 +19592,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -19653,12 +19653,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -19714,12 +19714,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -19775,12 +19775,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -19836,12 +19836,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -19897,12 +19897,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -19958,19 +19958,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -20024,15 +20024,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -20093,12 +20093,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
diff --git a/gencode/docs/state_mapping.html b/gencode/docs/state_mapping.html index 3cd0ca331d..8af8187831 100644 --- a/gencode/docs/state_mapping.html +++ b/gencode/docs/state_mapping.html @@ -15,20 +15,20 @@ Mapping State -

Mapping State

+
-
Type: object
+

Mapping State

Type: object

State for mapping

 No Additional Properties - + - - + + - +
@@ -53,18 +53,18 @@

devices

Type: object

Mapping state for all devices

 No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="devices_pattern1" onclick="setAnchor('#devices_pattern1')">Device Mapping State Pattern Property

@@ -74,7 +74,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression:
@@ -92,17 +92,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_mapping_device.json

Type: object
+ Device Mapping State

Device Mapping State

Type: object

State for mapping

 No Additional Properties - + - - + + - +
@@ -141,12 +141,12 @@

guid

Type: string

Device guid

 - + - - + + - +
@@ -186,15 +186,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - imported

Type: string
+ imported
Type: stringFormat: date-time

Last time the mapping was imported

 - + - - + + - +
@@ -234,15 +234,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - discoveredType: string
+ discoveredType: stringFormat: date-time

Last received discovery message

 - + - - + + - + @@ -282,15 +282,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - predictedType: string
+ predictedType: stringFormat: date-time

Last recommendation staging (result of automatic prediction)

 - + - - + + - + @@ -330,15 +330,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - promotedType: string
+ promotedType: stringFormat: date-time

Last recommendation promotion (result of manual QA)

 - + - - + + - + @@ -378,15 +378,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - exportedType: string
+ exportedType: stringFormat: date-time

Last time this device mapping was exported

 - + - - + + - + @@ -426,16 +426,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -481,12 +481,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -540,12 +540,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -592,7 +592,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -831,12 +831,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -885,12 +885,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -939,12 +939,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -993,12 +993,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -1047,12 +1047,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -1101,12 +1101,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1155,12 +1155,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1209,12 +1209,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1263,12 +1263,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1317,12 +1317,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1371,12 +1371,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1425,12 +1425,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1479,12 +1479,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1533,12 +1533,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1587,12 +1587,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1641,12 +1641,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1695,12 +1695,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1749,12 +1749,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1803,12 +1803,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1857,12 +1857,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1911,12 +1911,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1965,12 +1965,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -2019,12 +2019,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -2073,12 +2073,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -2127,12 +2127,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2181,12 +2181,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2235,12 +2235,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2289,12 +2289,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2343,12 +2343,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2397,12 +2397,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2451,12 +2451,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2505,12 +2505,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2559,12 +2559,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2613,12 +2613,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2667,12 +2667,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2721,12 +2721,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2775,19 +2775,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2834,15 +2834,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2896,12 +2896,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
diff --git a/gencode/docs/state_validation.html b/gencode/docs/state_validation.html index 6c2958a2da..34613a9d0b 100644 --- a/gencode/docs/state_validation.html +++ b/gencode/docs/state_validation.html @@ -15,20 +15,20 @@ Validation State -

Validation State

+
-
Type: object
+

Validation State

Type: object

Validation state summary

 No Additional Properties - + - - + + - +
@@ -50,15 +50,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestamp

Type: string
+ timestamp
Type: stringFormat: date-time

Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated

 - + - - + + -
+
Example:

"2019-01-17T14:02:29.364Z"
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

 - + - - + + - +
@@ -122,17 +122,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - cloud_versionType: object
+ cloud_version

Setup Udmi Config

Type: object

Version of the udmi cloud install

 - + - - + + - +
@@ -163,12 +163,12 @@

hostname

Type: string
- + - - + + - +
@@ -203,12 +203,12 @@

functions_minType: integer
- + - - + + - + @@ -243,12 +243,12 @@

functions_maxType: integer
- + - - + + - + @@ -284,12 +284,12 @@

udmi_versionType: string

Semantic tagged version of udmis install

 - + - - + + - + @@ -325,12 +325,12 @@

udmi_commitType: string

Commit hash of this udmis install

 - + - - + + - + @@ -366,12 +366,12 @@

udmi_refType: string

Complete reference of udmis install

 - + - - + + - + @@ -407,12 +407,12 @@

udmi_timeverType: string

Timestamp version id of udmis install

 - + - - + + - + @@ -445,14 +445,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - built_atType: string
+ built_atType: stringFormat: date-time
- + - - + + - + @@ -487,12 +487,12 @@

built_byType: string
- + - - + + - + @@ -525,14 +525,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - deployed_atType: string
+ deployed_atType: stringFormat: date-time
- + - - + + - + @@ -567,12 +567,12 @@

deployed_byType: string
- + - - + + - + @@ -605,12 +605,12 @@

udmi_versionType: string

Version of the local udmi tools

 - + - - + + - + @@ -636,15 +636,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_updatedType: string
+ last_updatedType: stringFormat: date-time

Last time this validation report was updated

 - + - - + + - + @@ -670,15 +670,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - start_timeType: string
+ start_timeType: stringFormat: date-time

timestamp of when the validation report was started

 - + - - + + - + @@ -704,16 +704,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -745,12 +745,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -790,12 +790,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -828,7 +828,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -1053,12 +1053,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -1093,12 +1093,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -1133,12 +1133,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -1173,12 +1173,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -1213,12 +1213,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -1253,12 +1253,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -1293,12 +1293,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -1333,12 +1333,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -1373,12 +1373,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -1413,12 +1413,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -1453,12 +1453,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -1493,12 +1493,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -1533,12 +1533,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -1573,12 +1573,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -1613,12 +1613,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -1653,12 +1653,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -1693,12 +1693,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -1733,12 +1733,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -1773,12 +1773,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -1813,12 +1813,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -1853,12 +1853,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -1893,12 +1893,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -1933,12 +1933,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -1973,12 +1973,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -2013,12 +2013,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -2053,12 +2053,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -2093,12 +2093,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -2133,12 +2133,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -2173,12 +2173,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -2213,12 +2213,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -2253,12 +2253,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -2293,12 +2293,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -2333,12 +2333,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -2373,12 +2373,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -2413,12 +2413,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -2453,12 +2453,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -2493,19 +2493,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -2538,15 +2538,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -2586,12 +2586,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -2627,18 +2627,18 @@

features

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="features_pattern1" onclick="setAnchor('#features_pattern1')">Feature Validation State Pattern Property

@@ -2648,7 +2648,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[.a-z]+$
@@ -2666,17 +2666,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_feature.json

Type: object
+ Feature Validation State

Feature Validation State

Type: object

Feature validation state

 No Additional Properties - + - - + + - +
@@ -2714,18 +2714,18 @@

sequences

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="features_pattern1_sequences_pattern1" onclick="setAnchor('#features_pattern1_sequences_pattern1')">Sequence Validation State Pattern Property

@@ -2735,7 +2735,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[_a-z]+$
@@ -2767,17 +2767,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_sequence.json

Type: object
+ Sequence Validation State

Sequence Validation State

Type: object

Sequence Validation State

 No Additional Properties - + - - + + - +
@@ -2829,12 +2829,12 @@

summary

Type: string
- + - - + + - +
@@ -2888,20 +2888,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
- +

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ - - + + - + @@ -2957,18 +2957,18 @@

capabilitiesType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="features_pattern1_sequences_pattern1_capabilities_pattern1" onclick="setAnchor('#features_pattern1_sequences_pattern1_capabilities_pattern1')">Capability Validation State Pattern Property

@@ -2978,7 +2978,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[.a-z]+$
@@ -3024,17 +3024,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_capability.json

Type: object
+ Capability Validation State

Capability Validation State

Type: object

Capability validation state

 No Additional Properties - + - - + + - +
@@ -3100,12 +3100,12 @@

summary

Type: string
- + - - + + - +
@@ -3173,20 +3173,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stageType: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -3254,17 +3254,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - resultType: enum (of string)
+ result

Capability result

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -3332,16 +3332,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -3415,12 +3415,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -3502,12 +3502,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -3582,7 +3582,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -3849,12 +3849,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -3931,12 +3931,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -4013,12 +4013,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -4095,12 +4095,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -4177,12 +4177,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -4259,12 +4259,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -4341,12 +4341,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -4423,12 +4423,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -4505,12 +4505,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -4587,12 +4587,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -4669,12 +4669,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -4751,12 +4751,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -4833,12 +4833,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -4915,12 +4915,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -4997,12 +4997,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -5079,12 +5079,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -5161,12 +5161,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -5243,12 +5243,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -5325,12 +5325,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -5407,12 +5407,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -5489,12 +5489,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -5571,12 +5571,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -5653,12 +5653,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -5735,12 +5735,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -5817,12 +5817,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -5899,12 +5899,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -5981,12 +5981,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -6063,12 +6063,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -6145,12 +6145,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -6227,12 +6227,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -6309,12 +6309,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -6391,12 +6391,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -6473,12 +6473,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -6555,12 +6555,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -6637,12 +6637,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -6719,12 +6719,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -6801,19 +6801,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -6888,15 +6888,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -6978,12 +6978,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -7061,12 +7061,12 @@

score

Type: integer
- + - - + + - + @@ -7136,12 +7136,12 @@

totalType: integer
- + - - + + - + @@ -7203,17 +7203,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - resultType: enum (of string)
+ result

Sequence Result

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -7267,16 +7267,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -7336,12 +7336,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -7409,12 +7409,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -7475,7 +7475,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -7728,12 +7728,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -7796,12 +7796,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -7864,12 +7864,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -7932,12 +7932,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -8000,12 +8000,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -8068,12 +8068,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -8136,12 +8136,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -8204,12 +8204,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -8272,12 +8272,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -8340,12 +8340,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -8408,12 +8408,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -8476,12 +8476,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -8544,12 +8544,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -8612,12 +8612,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -8680,12 +8680,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -8748,12 +8748,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -8816,12 +8816,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -8884,12 +8884,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -8952,12 +8952,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -9020,12 +9020,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -9088,12 +9088,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -9156,12 +9156,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -9224,12 +9224,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -9292,12 +9292,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -9360,12 +9360,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -9428,12 +9428,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -9496,12 +9496,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -9564,12 +9564,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -9632,12 +9632,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -9700,12 +9700,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -9768,12 +9768,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -9836,12 +9836,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -9904,12 +9904,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -9972,12 +9972,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -10040,12 +10040,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -10108,12 +10108,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -10176,19 +10176,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -10249,15 +10249,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -10325,12 +10325,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -10394,12 +10394,12 @@

scoring

Type: object
No Additional Properties - + - - + + - +
@@ -10458,12 +10458,12 @@

value

Type: integer
- + - - + + - +
@@ -10526,12 +10526,12 @@

totalType: integer
- + - - + + - + @@ -10579,18 +10579,18 @@

schemasType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="schemas_pattern1" onclick="setAnchor('#schemas_pattern1')">Schema Validation State Pattern Property

@@ -10600,7 +10600,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[.a-z]+$
@@ -10618,17 +10618,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_schema.json

Type: object
+ Schema Validation State

Schema Validation State

Type: object

Schema validation state

 No Additional Properties - + - - + + - +
@@ -10666,12 +10666,12 @@

stages

Type: object
No Additional Properties - + - - + + - +
@@ -10687,7 +10687,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[_a-z]+$
@@ -10721,12 +10721,12 @@

^[_a-z]+$

Type: object
- + - - + + - +

@@ -10772,18 +10772,18 @@

sequences

Type: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="schemas_pattern1_sequences_pattern1" onclick="setAnchor('#schemas_pattern1_sequences_pattern1')">Sequence Validation State Pattern Property

@@ -10793,7 +10793,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[_a-z]+$
@@ -10825,17 +10825,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_sequence.json

Type: object
+ Sequence Validation State

Sequence Validation State

Type: object

Sequence Validation State

 No Additional Properties - + - - + + - +
@@ -10887,12 +10887,12 @@

summary

Type: string
- + - - + + - +
@@ -10946,20 +10946,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stage

Type: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -11015,18 +11015,18 @@

capabilitiesType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="schemas_pattern1_sequences_pattern1_capabilities_pattern1" onclick="setAnchor('#schemas_pattern1_sequences_pattern1_capabilities_pattern1')">Capability Validation State Pattern Property

@@ -11036,7 +11036,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[.a-z]+$
@@ -11082,17 +11082,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - state_validation_capability.json

Type: object
+ Capability Validation State

Capability Validation State

Type: object

Capability validation state

 No Additional Properties - + - - + + - +
@@ -11158,12 +11158,12 @@

summary

Type: string
- + - - + + - +
@@ -11231,20 +11231,20 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - stageType: enum (of string)
+ stage

FeatureStage

Type: enum (of string)

Stage of a feature implemenation
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -11312,17 +11312,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - resultType: enum (of string)
+ result

Capability result

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -11390,16 +11390,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -11473,12 +11473,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -11560,12 +11560,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -11640,7 +11640,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -11907,12 +11907,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -11989,12 +11989,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -12071,12 +12071,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -12153,12 +12153,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -12235,12 +12235,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -12317,12 +12317,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -12399,12 +12399,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -12481,12 +12481,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -12563,12 +12563,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -12645,12 +12645,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -12727,12 +12727,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -12809,12 +12809,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -12891,12 +12891,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -12973,12 +12973,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - - - - + - + + + +
@@ -13055,12 +13055,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -13137,12 +13137,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -13219,12 +13219,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -13301,12 +13301,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -13383,12 +13383,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -13465,12 +13465,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -13547,12 +13547,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -13629,12 +13629,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -13711,12 +13711,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -13793,12 +13793,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -13875,12 +13875,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -13957,12 +13957,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -14039,12 +14039,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -14121,12 +14121,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -14203,12 +14203,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -14285,12 +14285,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -14367,12 +14367,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -14449,12 +14449,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -14531,12 +14531,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -14613,12 +14613,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -14695,12 +14695,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -14777,12 +14777,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -14859,19 +14859,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -14946,15 +14946,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -15036,12 +15036,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -15119,12 +15119,12 @@

score

Type: integer
- + - - + + - + @@ -15194,12 +15194,12 @@

totalType: integer
- + - - + + - + @@ -15261,17 +15261,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - resultType: enum (of string)
+ result

Sequence Result

Type: enum (of string)
-

Must be one of:

- -
- +

Must be one of:

+ + + - - + + - + @@ -15325,16 +15325,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -15394,12 +15394,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -15467,12 +15467,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -15533,7 +15533,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -15786,12 +15786,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -15854,12 +15854,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -15922,12 +15922,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -15990,12 +15990,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -16058,12 +16058,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -16126,12 +16126,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -16194,12 +16194,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -16262,12 +16262,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -16330,12 +16330,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -16398,12 +16398,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -16466,12 +16466,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -16534,12 +16534,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -16602,12 +16602,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -16670,12 +16670,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -16738,12 +16738,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -16806,12 +16806,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -16874,12 +16874,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -16942,12 +16942,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -17010,12 +17010,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -17078,12 +17078,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -17146,12 +17146,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -17214,12 +17214,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -17282,12 +17282,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -17350,12 +17350,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -17418,12 +17418,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -17486,12 +17486,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -17554,12 +17554,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -17622,12 +17622,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -17690,12 +17690,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -17758,12 +17758,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -17826,12 +17826,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -17894,12 +17894,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -17962,12 +17962,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -18030,12 +18030,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -18098,12 +18098,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -18166,12 +18166,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -18234,19 +18234,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -18307,15 +18307,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -18383,12 +18383,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
@@ -18452,12 +18452,12 @@

scoring

Type: object
No Additional Properties - + - - + + - +
@@ -18516,12 +18516,12 @@

value

Type: integer
- + - - + + - +
@@ -18584,12 +18584,12 @@

totalType: integer
- + - - + + - + @@ -18635,14 +18635,14 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - summaryType: object
+ summary

Validation Summary

Type: object
No Additional Properties - + - - + + - +
@@ -18673,12 +18673,12 @@

correct_devices

Type: array of string
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -18706,12 +18706,12 @@

Each item of this array must be:

correct_devices items
Type: string
- + - - + + - +
@@ -18748,12 +18748,12 @@

extra_devicesType: array of string
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -18781,12 +18781,12 @@

Each item of this array must be:

extra_devices items
Type: string
- + - - + + - +
@@ -18823,12 +18823,12 @@

missing_devicesType: array of string
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -18856,12 +18856,12 @@

Each item of this array must be:

missing_devices items
Type: string
- + - - + + - +
@@ -18898,12 +18898,12 @@

error_devicesType: array of string
- + - - + + -

Each item of this array must be:

+ No Additional Items

Each item of this array must be:

@@ -18931,12 +18931,12 @@

Each item of this array must be:

error_devices items
Type: string
- + - - + + - +
@@ -18970,18 +18970,18 @@

devicesType: object
No Additional Properties - + - - + + - +

+ aria-expanded="" aria-controls="devices_pattern1" onclick="setAnchor('#devices_pattern1')">Device Validation Events Pattern Property

@@ -18991,7 +18991,7 @@

-

All property whose name matches the following regular expression must respect the following conditions

+

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[A-Z]{2,6}-[1-9][0-9]*$
@@ -19009,17 +19009,17 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - events_validation_device.json

Type: object
+ Device Validation Events

Device Validation Events

Type: object

Validation summary information for an individual device.

 No Additional Properties - + - - + + - +
@@ -19055,15 +19055,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - last_seen

Type: string
+ last_seen
Type: stringFormat: date-time

Last time any message from this device was received

 - + - - + + - +
@@ -19103,15 +19103,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - oldest_markType: string
+ oldest_markType: stringFormat: date-time

Oldest recorded mark for this device

 - + - - + + - + @@ -19151,16 +19151,16 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - statusType: object
+ status

Entry

Type: object
No Additional Properties - + - - + + - +
@@ -19206,12 +19206,12 @@

message

Type: string

A human-readable one-line description of the entry

 - + - - + + -
+
Example:

"Point is not writable"
@@ -19265,12 +19265,12 @@

detail

Type: string

An optional extensive entry which can include more detail, e.g. a complete program stack-trace

 - + - - + + - +
@@ -19317,7 +19317,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - categoryType: string
+ category

Category

Type: string

@@ -19556,12 +19556,12 @@

item 0

Type: object
Must match regular expression: ^system\.base\.start$ - + - - + + - +
@@ -19610,12 +19610,12 @@

item 1

Type: object
Must match regular expression: ^system\.base\.shutdown$ - + - - + + - +
@@ -19664,12 +19664,12 @@

item 2

Type: object
Must match regular expression: ^system\.base\.ready$ - + - - + + - +
@@ -19718,12 +19718,12 @@

item 3

Type: object
Must match regular expression: ^system\.config\.receive$ - + - - + + - +
@@ -19772,12 +19772,12 @@

item 4

Type: object
Must match regular expression: ^system\.config\.parse$ - + - - + + - +
@@ -19826,12 +19826,12 @@

item 5

Type: object
Must match regular expression: ^system\.config\.apply$ - + - - + + - +
@@ -19880,12 +19880,12 @@

item 6

Type: object
Must match regular expression: ^system\.auth\.login$ - + - - + + - +
@@ -19934,12 +19934,12 @@

item 7

Type: object
Must match regular expression: ^system\.auth\.logout$ - + - - + + - +
@@ -19988,12 +19988,12 @@

item 8

Type: object
Must match regular expression: ^system\.auth\.fail$ - + - - + + - +
@@ -20042,12 +20042,12 @@

item 9

Type: object
Must match regular expression: ^pointset\.point\.nominal$ - + - - + + - +
@@ -20096,12 +20096,12 @@

item 10

Type: object
Must match regular expression: ^pointset\.point\.applied$ - + - - + + - +
@@ -20150,12 +20150,12 @@

item 11

Type: object
Must match regular expression: ^pointset\.point\.updating$ - + - - + + - +
@@ -20204,12 +20204,12 @@

item 12

Type: object
Must match regular expression: ^pointset\.point\.overridden$ - + - - + + - +
@@ -20258,12 +20258,12 @@

item 13

Type: object
Must match regular expression: ^pointset\.point\.failure$ - + - - + + - +
@@ -20312,12 +20312,12 @@

item 14

Type: object
Must match regular expression: ^pointset\.point\.invalid$ - + - - + + - +
@@ -20366,12 +20366,12 @@

item 15

Type: object
Must match regular expression: ^localnet\.network$ - + - - + + - +
@@ -20420,12 +20420,12 @@

item 16

Type: object
Must match regular expression: ^localnet\.network\.connect$ - + - - + + - +
@@ -20474,12 +20474,12 @@

item 17

Type: object
Must match regular expression: ^gateway\.setup\.attach$ - + - - + + - +
@@ -20528,12 +20528,12 @@

item 18

Type: object
Must match regular expression: ^gateway\.proxy\.target$ - + - - + + - +
@@ -20582,12 +20582,12 @@

item 19

Type: object
Must match regular expression: ^gateway\.proxy\.connect$ - + - - + + - +
@@ -20636,12 +20636,12 @@

item 20

Type: object
Must match regular expression: ^discovery\.family\.scan$ - + - - + + - +
@@ -20690,12 +20690,12 @@

item 21

Type: object
Must match regular expression: ^discovery\.device\.enumerate$ - + - - + + - +
@@ -20744,12 +20744,12 @@

item 22

Type: object
Must match regular expression: ^discovery\.point\.describe$ - + - - + + - +
@@ -20798,12 +20798,12 @@

item 23

Type: object
Must match regular expression: ^mapping\.device\.apply$ - + - - + + - +
@@ -20852,12 +20852,12 @@

item 24

Type: object
Must match regular expression: ^blobset\.blob\.receive$ - + - - + + - +
@@ -20906,12 +20906,12 @@

item 25

Type: object
Must match regular expression: ^blobset\.blob\.fetch$ - + - - + + - +
@@ -20960,12 +20960,12 @@

item 26

Type: object
Must match regular expression: ^blobset\.blob\.apply$ - + - - + + - +
@@ -21014,12 +21014,12 @@

item 27

Type: object
Must match regular expression: ^validation\.device\.receive$ - + - - + + - +
@@ -21068,12 +21068,12 @@

item 28

Type: object
Must match regular expression: ^validation\.device\.schema$ - + - - + + - +
@@ -21122,12 +21122,12 @@

item 29

Type: object
Must match regular expression: ^validation\.device\.content$ - + - - + + - +
@@ -21176,12 +21176,12 @@

item 30

Type: object
Must match regular expression: ^validation\.device\.multiple$ - + - - + + - +
@@ -21230,12 +21230,12 @@

item 31

Type: object
Must match regular expression: ^validation\.device\.extra$ - + - - + + - +
@@ -21284,12 +21284,12 @@

item 32

Type: object
Must match regular expression: ^validation\.summary\.report$ - + - - + + - +
@@ -21338,12 +21338,12 @@

item 33

Type: object
Must match regular expression: ^validation\.feature\.sequence$ - + - - + + - +
@@ -21392,12 +21392,12 @@

item 34

Type: object
Must match regular expression: ^validation\.feature\.schema$ - + - - + + - +
@@ -21446,12 +21446,12 @@

item 35

Type: object
Must match regular expression: ^validation\.feature\.capability$ - + - - + + - +
@@ -21500,19 +21500,19 @@

item 36

Type: object
Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - + - - + + - + - + - - + + - + @@ -21559,15 +21559,15 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - timestampType: string
+ timestampType: stringFormat: date-time

FC 3339 UTC timestamp the condition was triggered, or most recently updated

 - + - - + + -
+
Example:

"2018-08-26T21:39:28.364Z"
@@ -21621,12 +21621,12 @@

level

Type: integer

The status level should conform to the numerical Stackdriver LogEntry levels. The DEFAULT value of 0 is not allowed (lowest value is 100, maximum 800).

 - + - -

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

+ +

Value must be greater or equal to 100 and lesser or equal to 800 and a multiple of 1

-
+
Example:

600
From 80c9afe54199b05d0f345ad01fc55177258082a3 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 07:20:40 -0800 Subject: [PATCH 3/8] Fixing validator --- .../google/daq/mqtt/mapping/MappingAgent.java | 6 ++--- .../google/daq/mqtt/registrar/Registrar.java | 15 ++++++----- .../google/daq/mqtt/registrar/Summarizer.java | 6 ++--- .../daq/mqtt/sequencer/SequenceBase.java | 2 +- .../google/daq/mqtt/util/CloudIotManager.java | 11 ++++---- .../google/daq/mqtt/util/IotMockProvider.java | 4 +-- .../daq/mqtt/util/IotReflectorClient.java | 26 +++++++++---------- .../google/daq/mqtt/validator/Validator.java | 4 +-- .../google/daq/mqtt/validator/BasicTest.java | 4 +-- 9 files changed, 40 insertions(+), 38 deletions(-) diff --git a/validator/src/main/java/com/google/daq/mqtt/mapping/MappingAgent.java b/validator/src/main/java/com/google/daq/mqtt/mapping/MappingAgent.java index 6cedd79a7d..6840e07e97 100644 --- a/validator/src/main/java/com/google/daq/mqtt/mapping/MappingAgent.java +++ b/validator/src/main/java/com/google/daq/mqtt/mapping/MappingAgent.java @@ -34,7 +34,7 @@ import java.util.Map.Entry; import java.util.Set; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.DiscoveryConfig; import udmi.schema.DiscoveryEvents; import udmi.schema.Enumerations.Depth; @@ -108,7 +108,7 @@ void process(List argsList) { private void setupProvision() { CloudModel cloudModel = new CloudModel(); cloudModel.metadata = ImmutableMap.of(UDMI_PROVISION_ENABLE, "true"); - cloudIotManager.updateDevice(deviceId, cloudModel, Operation.MODIFY); + cloudIotManager.updateDevice(deviceId, cloudModel, ModelOperation.MODIFY); } private void initiateDiscover() { @@ -120,7 +120,7 @@ private void initiateDiscover() { String generation = isoConvert(generationDate); CloudModel cloudModel = new CloudModel(); cloudModel.metadata = ImmutableMap.of(UDMI_PROVISION_GENERATION, generation); - cloudIotManager.updateDevice(deviceId, cloudModel, Operation.MODIFY); + cloudIotManager.updateDevice(deviceId, cloudModel, ModelOperation.MODIFY); System.err.printf("Initiating %s discovery on %s/%s at %s%n", families, siteModel.getRegistryId(), deviceId, generation); diff --git a/validator/src/main/java/com/google/daq/mqtt/registrar/Registrar.java b/validator/src/main/java/com/google/daq/mqtt/registrar/Registrar.java index 217381d63e..c061d0f638 100644 --- a/validator/src/main/java/com/google/daq/mqtt/registrar/Registrar.java +++ b/validator/src/main/java/com/google/daq/mqtt/registrar/Registrar.java @@ -102,7 +102,7 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.VisibleForTesting; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.Credential; import udmi.schema.Envelope.SubFolder; @@ -348,7 +348,7 @@ protected Map getWorkingDevices() { private void processSiteMetadata() { ifTrueThen(updateCloudIoT, - () -> cloudIotManager.updateRegistry(getSiteMetadata(), Operation.UPDATE)); + () -> cloudIotManager.updateRegistry(getSiteMetadata(), ModelOperation.UPDATE)); } private SiteMetadata getSiteMetadata() { @@ -755,7 +755,7 @@ private void deleteDevice(Set allDevices, String deviceId) { */ private void unbindDevicesFromGateways(Set allDevices, Set boundGateways) { boundGateways.forEach(gatewayId -> { - synchronized (Operation.UNBIND) { + synchronized (ModelOperation.UNBIND) { Map boundDevices = cloudIotManager.fetchDevice(gatewayId).device_ids; Set toUnbind = new HashSet<>(intersection(allDevices, boundDevices.keySet())); System.err.printf("Unbinding from gateway %s: %s%n", gatewayId, setOrSize(toUnbind)); @@ -930,9 +930,10 @@ private CloudModel processExtra(String extraName, AtomicInteger alreadyBlocked) cloudIotManager.blockDevice(extraName, true); cloudModel.blocked = true; } - cloudModel.operation = ifTrueGet(cloudModel.blocked, Operation.BLOCK, Operation.ALLOW); + cloudModel.operation = ifTrueGet(cloudModel.blocked, ModelOperation.BLOCK, + ModelOperation.ALLOW); } catch (Exception e) { - cloudModel.operation = Operation.ERROR; + cloudModel.operation = ModelOperation.ERROR; cloudModel.detail = friendlyStackTrace(e); System.err.printf("Blocking device %s: %s%n", extraName, cloudModel.detail); } @@ -1264,7 +1265,7 @@ private void previewModels(Map localDevices) { return; } - cloudIotManager.updateRegistry(getSiteMetadata(), Operation.PREVIEW); + cloudIotManager.updateRegistry(getSiteMetadata(), ModelOperation.PREVIEW); try { AtomicInteger previewCount = new AtomicInteger(); @@ -1273,7 +1274,7 @@ private void previewModels(Map localDevices) { ifTrueThen(baseCount % 100 == 0, () -> System.err.printf("Sending preview for device %d/%d...%n", baseCount + 1, localDevices.size())); - cloudIotManager.updateDevice(id, device.getSettings(), Operation.PREVIEW); + cloudIotManager.updateDevice(id, device.getSettings(), ModelOperation.PREVIEW); })); dynamicTerminate(localDevices.size()); System.err.printf("Finished sending device preview for %d devices.%n", localDevices.size()); diff --git a/validator/src/main/java/com/google/daq/mqtt/registrar/Summarizer.java b/validator/src/main/java/com/google/daq/mqtt/registrar/Summarizer.java index 56e8b42d30..31976262e4 100644 --- a/validator/src/main/java/com/google/daq/mqtt/registrar/Summarizer.java +++ b/validator/src/main/java/com/google/daq/mqtt/registrar/Summarizer.java @@ -17,7 +17,7 @@ import java.util.Set; import java.util.TreeSet; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; abstract class Summarizer { @@ -77,14 +77,14 @@ public void summarize(Map localDevices, Map private void correlateModels(LocalDevice localDevice, CloudModel cloudModel) { if (localDevice != null && cloudModel != null && localDevice.hasErrors()) { - cloudModel.operation = Operation.ERROR; + cloudModel.operation = ModelOperation.ERROR; } } private Map extractDeviceRow(CloudModel cloudModel) { return ImmutableMap.of( NUM_ID_HEADER, ofNullable(cloudModel.num_id).orElse(UNKNOWN_NUM_ID), - STATUS_HEADER, ofNullable(cloudModel.operation).orElse(Operation.READ).toString(), + STATUS_HEADER, ofNullable(cloudModel.operation).orElse(ModelOperation.READ).toString(), ACTIVE_HEADER, JsonUtil.isoConvert(cloudModel.last_event_time), DETAIL_HEADER, ofNullable(cloudModel.detail).orElse(NO_DETAIL)); } diff --git a/validator/src/main/java/com/google/daq/mqtt/sequencer/SequenceBase.java b/validator/src/main/java/com/google/daq/mqtt/sequencer/SequenceBase.java index 85b65b7b0a..83acc68726 100644 --- a/validator/src/main/java/com/google/daq/mqtt/sequencer/SequenceBase.java +++ b/validator/src/main/java/com/google/daq/mqtt/sequencer/SequenceBase.java @@ -60,7 +60,7 @@ import static udmi.schema.Category.VALIDATION_FEATURE_CAPABILITY; import static udmi.schema.Category.VALIDATION_FEATURE_SCHEMA; import static udmi.schema.Category.VALIDATION_FEATURE_SEQUENCE; -import static udmi.schema.CloudModel.Operation.REPLY; +import static udmi.schema.CloudModel.ModelOperation.REPLY; import static udmi.schema.Envelope.SubFolder.UPDATE; import static udmi.schema.FeatureDiscovery.FeatureStage.ALPHA; import static udmi.schema.FeatureDiscovery.FeatureStage.PREVIEW; diff --git a/validator/src/main/java/com/google/daq/mqtt/util/CloudIotManager.java b/validator/src/main/java/com/google/daq/mqtt/util/CloudIotManager.java index 8ce5817ada..abb557e290 100644 --- a/validator/src/main/java/com/google/daq/mqtt/util/CloudIotManager.java +++ b/validator/src/main/java/com/google/daq/mqtt/util/CloudIotManager.java @@ -30,7 +30,7 @@ import java.util.Set; import java.util.concurrent.ConcurrentHashMap; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.CloudModel.Resource_type; import udmi.schema.Credential; import udmi.schema.Credential.Key_format; @@ -311,18 +311,19 @@ private void createDevice(String deviceId, CloudDeviceSettings settings) { deviceMap.put(deviceId, newDevice); } - public void updateDevice(String deviceId, CloudDeviceSettings settings, Operation operation) { + public void updateDevice(String deviceId, CloudDeviceSettings settings, + ModelOperation operation) { updateDevice(deviceId, makeDevice(settings, null), operation); } public void updateDevice(String deviceId, CloudDeviceSettings settings, CloudModel oldDevice) { - updateDevice(deviceId, makeDevice(settings, oldDevice), Operation.UPDATE); + updateDevice(deviceId, makeDevice(settings, oldDevice), ModelOperation.UPDATE); } /** * Update a device using the given operation parameter. */ - public void updateDevice(String deviceId, CloudModel device, Operation operation) { + public void updateDevice(String deviceId, CloudModel device, ModelOperation operation) { limitValueSizes(device.metadata); device.operation = operation; getIotProvider().updateDevice(deviceId, device); @@ -440,7 +441,7 @@ public String createRegistry(String suffix) { /** * Update the cloud site metadata for the current registry. */ - public void updateRegistry(SiteMetadata siteMetadata, Operation operation) { + public void updateRegistry(SiteMetadata siteMetadata, ModelOperation operation) { CloudModel registryModel = new CloudModel(); registryModel.resource_type = Resource_type.REGISTRY; registryModel.operation = operation; diff --git a/validator/src/main/java/com/google/daq/mqtt/util/IotMockProvider.java b/validator/src/main/java/com/google/daq/mqtt/util/IotMockProvider.java index e5180ab9a7..6c755b7c82 100644 --- a/validator/src/main/java/com/google/daq/mqtt/util/IotMockProvider.java +++ b/validator/src/main/java/com/google/daq/mqtt/util/IotMockProvider.java @@ -22,7 +22,7 @@ import java.util.Set; import java.util.stream.Collectors; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.Envelope.SubFolder; import udmi.schema.ExecutionConfiguration; import udmi.schema.Metadata; @@ -127,7 +127,7 @@ public void bindGatewayDevices(String gatewayDeviceId, Set proxyDeviceId checkArgument(cloudDevices.containsKey(gatewayDeviceId), "missing gateway device"); checkArgument(populateCloudModel(gatewayDeviceId).resource_type == GATEWAY, "not a gateway"); mockAction(BIND_DEVICE_ACTION, proxyDeviceId, gatewayDeviceId, - (toBind ? Operation.BIND : Operation.UNBIND).value()); + (toBind ? ModelOperation.BIND : ModelOperation.UNBIND).value()); }); } diff --git a/validator/src/main/java/com/google/daq/mqtt/util/IotReflectorClient.java b/validator/src/main/java/com/google/daq/mqtt/util/IotReflectorClient.java index d6a4ed70ed..91bb9657d8 100644 --- a/validator/src/main/java/com/google/daq/mqtt/util/IotReflectorClient.java +++ b/validator/src/main/java/com/google/daq/mqtt/util/IotReflectorClient.java @@ -16,12 +16,12 @@ import static com.google.udmi.util.JsonUtil.stringifyTerse; import static java.lang.String.format; import static java.util.Optional.ofNullable; -import static udmi.schema.CloudModel.Operation.BIND; -import static udmi.schema.CloudModel.Operation.BLOCK; -import static udmi.schema.CloudModel.Operation.BOUND; -import static udmi.schema.CloudModel.Operation.DELETE; -import static udmi.schema.CloudModel.Operation.READ; -import static udmi.schema.CloudModel.Operation.UNBIND; +import static udmi.schema.CloudModel.ModelOperation.BIND; +import static udmi.schema.CloudModel.ModelOperation.BLOCK; +import static udmi.schema.CloudModel.ModelOperation.BOUND; +import static udmi.schema.CloudModel.ModelOperation.DELETE; +import static udmi.schema.CloudModel.ModelOperation.READ; +import static udmi.schema.CloudModel.ModelOperation.UNBIND; import com.google.common.base.Preconditions; import com.google.daq.mqtt.util.MessagePublisher.QuerySpeed; @@ -39,7 +39,7 @@ import java.util.concurrent.Executors; import java.util.concurrent.TimeUnit; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.Credential; import udmi.schema.Envelope.SubFolder; import udmi.schema.ExecutionConfiguration; @@ -117,19 +117,19 @@ public void setBlocked(String deviceId, boolean blocked) { @Override public void updateDevice(String deviceId, CloudModel device) { - device.operation = ofNullable(device.operation).orElse(Operation.UPDATE); + device.operation = ofNullable(device.operation).orElse(ModelOperation.UPDATE); cloudModelTransaction(deviceId, CLOUD_MODEL_TOPIC, device); } @Override public void updateRegistry(CloudModel registry) { - registry.operation = ofNullable(registry.operation).orElse(Operation.UPDATE); + registry.operation = ofNullable(registry.operation).orElse(ModelOperation.UPDATE); cloudModelTransaction(null, CLOUD_MODEL_TOPIC, registry); } @Override public void createResource(String deviceId, CloudModel makeDevice) { - makeDevice.operation = Operation.CREATE; + makeDevice.operation = ModelOperation.CREATE; CloudModel created = cloudModelTransaction(deviceId, CLOUD_MODEL_TOPIC, makeDevice); ifNotNullThen(makeDevice.num_id, () -> ifTrueThen(!makeDevice.num_id.equals(created.num_id), () -> System.err.printf("created num_id %s does not match expected %s%n", created.num_id, @@ -140,7 +140,7 @@ public void createResource(String deviceId, CloudModel makeDevice) { @Override public void deleteDevice(String deviceId, Set unbindIds) { CloudModel deleteModel = new CloudModel(); - deleteModel.operation = Operation.DELETE; + deleteModel.operation = ModelOperation.DELETE; deleteModel.gateway = ifNotNullGet(unbindIds, this::proxyGatewayModel); cloudModelTransaction(deviceId, CLOUD_MODEL_TOPIC, deleteModel); } @@ -152,12 +152,12 @@ private GatewayModel proxyGatewayModel(Set unbindIds) { } private CloudModel cloudModelTransaction(String deviceId, String topic, CloudModel model) { - Operation operation = Preconditions.checkNotNull(model.operation, "no operation"); + ModelOperation operation = Preconditions.checkNotNull(model.operation, "no operation"); model.functions_ver = TOOLS_FUNCTIONS_VERSION; Map message = transaction(deviceId, topic, stringify(model), QuerySpeed.LONG); CloudModel cloudModel = convertTo(CloudModel.class, message); String cloudNumId = ifNotNullGet(cloudModel, result -> result.num_id); - Operation cloudOperation = ifNotNullGet(cloudModel, result -> result.operation); + ModelOperation cloudOperation = ifNotNullGet(cloudModel, result -> result.operation); // This happens with devices are bound to gateways, so explicitly capture the relevant info. if (operation == DELETE && cloudOperation == BOUND) { throw new DeviceGatewayBoundException(cloudModel); diff --git a/validator/src/main/java/com/google/daq/mqtt/validator/Validator.java b/validator/src/main/java/com/google/daq/mqtt/validator/Validator.java index e8df6b34fa..caf5e2b8f2 100644 --- a/validator/src/main/java/com/google/daq/mqtt/validator/Validator.java +++ b/validator/src/main/java/com/google/daq/mqtt/validator/Validator.java @@ -110,7 +110,7 @@ import org.apache.commons.io.FileUtils; import org.slf4j.impl.SimpleLogger; import udmi.schema.Category; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.DeviceValidationEvents; import udmi.schema.Envelope; import udmi.schema.Envelope.SubFolder; @@ -630,7 +630,7 @@ private boolean handleMetadataUpdate(Map attributes, Object mess requireNonNull(messageObject, "messageObject is null")); ReportingDevice device = reportingDevices.computeIfAbsent(deviceId, this::newReportingDevice); - if (catchToNull(() -> metadata.cloud.operation) == Operation.DELETE) { + if (catchToNull(() -> metadata.cloud.operation) == ModelOperation.DELETE) { reportingDevices.remove(deviceId); } else { ifNotNullThen(metadata.system, () -> { diff --git a/validator/src/test/java/com/google/daq/mqtt/validator/BasicTest.java b/validator/src/test/java/com/google/daq/mqtt/validator/BasicTest.java index 9847295b65..b5a298002b 100644 --- a/validator/src/test/java/com/google/daq/mqtt/validator/BasicTest.java +++ b/validator/src/test/java/com/google/daq/mqtt/validator/BasicTest.java @@ -20,7 +20,7 @@ import java.util.Set; import org.junit.Test; import udmi.schema.CloudModel; -import udmi.schema.CloudModel.Operation; +import udmi.schema.CloudModel.ModelOperation; import udmi.schema.Config; import udmi.schema.DeviceValidationEvents; import udmi.schema.DiscoveryEvents; @@ -176,7 +176,7 @@ public void deviceDeleteMetadataUpdate() { messageObject.version = TestCommon.UDMI_VERSION; messageObject.system = new SystemModel(); messageObject.cloud = new CloudModel(); - messageObject.cloud.operation = Operation.DELETE; + messageObject.cloud.operation = ModelOperation.DELETE; MessageBundle messageBundle = getMessageBundle(MODEL_SUBTYPE, UPDATE_SUBFOLDER, messageObject); validator.validateMessage(messageBundle); From 1e12c1c0f3edf1e921fe15c28eb6018ed9257455 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 07:28:01 -0800 Subject: [PATCH 4/8] Fix local out testing --- bin/test_runlocal | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/bin/test_runlocal b/bin/test_runlocal index a72c5ac8db..dbd59227b7 100755 --- a/bin/test_runlocal +++ b/bin/test_runlocal @@ -15,13 +15,13 @@ echo Captured $(wc -l out/message_capture.log) messages. systems=$(find out/registries/ -name \*update_model.json | xargs jq .system | fgrep -v null | wc -l) || true [[ $systems == 269 ]] || fail Expected 269 system operations, found $systems -deletes=$(find out/registries/ -name \*update_model.json | xargs jq .cloud.operation | fgrep DELETE | wc -l) || true +deletes=$(find out/registries/ -name \*update_model.json | xargs jq .operation | fgrep DELETE | wc -l) || true [[ $deletes == 1 ]] || fail Expected 1 delete operations, found $deletes -binds=$(find out/registries/ -name \*update_model.json | xargs jq .cloud.operation | fgrep BIND | wc -l) || true +binds=$(find out/registries/ -name \*update_model.json | xargs jq .operation | fgrep BIND | wc -l) || true [[ $binds == 3 ]] || fail Expected 3 bind operations, found $binds -blocks=$(find out/registries/ -name \*update_model.json | xargs jq .cloud.operation | fgrep BLOCK | wc -l) || true +blocks=$(find out/registries/ -name \*update_model.json | xargs jq .operation | fgrep BLOCK | wc -l) || true [[ $blocks == 1 ]] || fail Expected 1 block operations, found $blocks echo Done with successful runlocal validation. From 436c769fbacc16f1fe373c098cdc02cc90995098 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 07:30:46 -0800 Subject: [PATCH 5/8] Fix output --- tests/sites/downgrade/devices/DWN-2/expected/errors.map | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/sites/downgrade/devices/DWN-2/expected/errors.map b/tests/sites/downgrade/devices/DWN-2/expected/errors.map index dc89501ed2..2c430d233d 100644 --- a/tests/sites/downgrade/devices/DWN-2/expected/errors.map +++ b/tests/sites/downgrade/devices/DWN-2/expected/errors.map @@ -2,4 +2,4 @@ Exceptions for DWN-2 While loading device metadata for DWN-2 While converting strict to udmi.schema.Metadata While converting string/string to udmi.schema.Metadata - Unrecognized field "grumpy" (class udmi.schema.Metadata), not marked as ignorable (13 known properties: "upgraded_from", "gateway", "hash", "system", "discovery", "localnet", "structure", "cloud", "timestamp", "version", "features", "testing", "pointset"]) at [Source: (String)"{ "cloud" : { "auth_type" : "RS256" }, "grumpy" : { "reason" : "This is an intentional schema violation to test the tools" }, "hash" : "da852d15", "localnet" : { "families" : { "vendor" : { "addr" : "0x65" } } }, "pointset" : { "exclude_units_from_config" : true, "points" : { "filter_alarm_pressure_status" : { "ref" : "BV11.present_value", "units" : "No-units" }, "filter_differential_pressure" : { "[truncated 667 chars]; line: 5, column: 15] (through reference chain: udmi.schema.Metadata["grumpy"]) + Unrecognized field "grumpy" (class udmi.schema.Metadata), not marked as ignorable (14 known properties: "upgraded_from", "gateway", "operation", "hash", "system", "discovery", "localnet", "structure", "cloud", "timestamp", "version", "features", "testing", "pointset"]) at [Source: (String)"{ "cloud" : { "auth_type" : "RS256" }, "grumpy" : { "reason" : "This is an intentional schema violation to test the tools" }, "hash" : "da852d15", "localnet" : { "families" : { "vendor" : { "addr" : "0x65" } } }, "pointset" : { "exclude_units_from_config" : true, "points" : { "filter_alarm_pressure_status" : { "ref" : "BV11.present_value", "units" : "No-units" }, "filter_differential_pressure" : { "[truncated 667 chars]; line: 5, column: 15] (through reference chain: udmi.schema.Metadata["grumpy"]) From 9199cf4679e879bb9ce41252fcaa9a3f762831ac Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 07:40:37 -0800 Subject: [PATCH 6/8] Adding gencode diagnostics --- BridgePodConfiguration.java | 66 +++++++++++++++++++++++++++++++++++++ bin/gencode | 3 ++ 2 files changed, 69 insertions(+) create mode 100644 BridgePodConfiguration.java diff --git a/BridgePodConfiguration.java b/BridgePodConfiguration.java new file mode 100644 index 0000000000..09122ccf95 --- /dev/null +++ b/BridgePodConfiguration.java @@ -0,0 +1,66 @@ + +package udmi.schema; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyDescription; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +/** + * Bridge Pod Configuration + *

+ * Parameters to define a bridge between message domains + * + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonPropertyOrder({ + "enabled", + "from", + "morf" +}) +public class BridgePodConfiguration { + + @JsonProperty("enabled") + public String enabled; + /** + * Endpoint Configuration + *

+ * Parameters to define a message endpoint + * + */ + @JsonProperty("from") + @JsonPropertyDescription("Parameters to define a message endpoint") + public EndpointConfiguration from; + /** + * Endpoint Configuration + *

+ * Parameters to define a message endpoint + * + */ + @JsonProperty("morf") + @JsonPropertyDescription("Parameters to define a message endpoint") + public EndpointConfiguration morf; + + @Override + public int hashCode() { + int result = 1; + result = ((result* 31)+((this.morf == null)? 0 :this.morf.hashCode())); + result = ((result* 31)+((this.enabled == null)? 0 :this.enabled.hashCode())); + result = ((result* 31)+((this.from == null)? 0 :this.from.hashCode())); + return result; + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if ((other instanceof BridgePodConfiguration) == false) { + return false; + } + BridgePodConfiguration rhs = ((BridgePodConfiguration) other); + return ((((this.morf == rhs.morf)||((this.morf!= null)&&this.morf.equals(rhs.morf)))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled))))&&((this.from == rhs.from)||((this.from!= null)&&this.from.equals(rhs.from)))); + } + +} diff --git a/bin/gencode b/bin/gencode index 70cab56c61..ef89e62b0f 100755 --- a/bin/gencode +++ b/bin/gencode @@ -34,6 +34,9 @@ if [[ -n $check ]]; then echo Checking gencode docs links... bin/gencode_docs_checklinks + echo Diff that one file... + diff BridgePodConfiguration.java gencode/java/udmi/schema/BridgePodConfiguration.java + files=`find gencode/ -type f | sort` sha256sum $files > /tmp/gencode.hash echo Checking gencode hash: diff /tmp/gencode.hash .gencode_hash.txt From d94344f7117c23b737127c1d02ad418713160016 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 09:31:05 -0800 Subject: [PATCH 7/8] Upping java to 21 --- .github/workflows/testing.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index ba72a06187..975f85c79c 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -22,7 +22,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - uses: actions/setup-python@v5 with: python-version: '3.10' From 9ef87601462f59db2b8390b7744876a1a19ffbd1 Mon Sep 17 00:00:00 2001 From: Trevor Pering Date: Wed, 19 Feb 2025 09:40:04 -0800 Subject: [PATCH 8/8] Upping java version to 21 everywhere --- .github/workflows/integration.yaml | 4 +- .github/workflows/testing.yml | 12 +++--- BridgePodConfiguration.java | 66 ------------------------------ bin/gencode | 13 +++--- 4 files changed, 13 insertions(+), 82 deletions(-) delete mode 100644 BridgePodConfiguration.java diff --git a/.github/workflows/integration.yaml b/.github/workflows/integration.yaml index a290797039..d47b7e8f35 100644 --- a/.github/workflows/integration.yaml +++ b/.github/workflows/integration.yaml @@ -32,7 +32,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: Log in to the github registry uses: docker/login-action@v3 with: @@ -85,7 +85,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: Publish maven package run: pubber/bin/publish diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml index 975f85c79c..89fe6280d9 100644 --- a/.github/workflows/testing.yml +++ b/.github/workflows/testing.yml @@ -78,7 +78,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: base setup run: | bin/setup_base @@ -129,7 +129,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: base setup run: bin/run_tests install_dependencies - name: local setup @@ -184,7 +184,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: base setup run: bin/run_tests install_dependencies - name: local setup @@ -236,7 +236,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: base setup run: | bin/setup_base @@ -291,7 +291,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: base setup run: bin/run_tests install_dependencies - name: local setup @@ -369,7 +369,7 @@ jobs: - uses: actions/setup-java@v4 with: distribution: 'temurin' - java-version: '17' + java-version: '21' - name: Setup prerequisites run: | bin/setup_base diff --git a/BridgePodConfiguration.java b/BridgePodConfiguration.java deleted file mode 100644 index 09122ccf95..0000000000 --- a/BridgePodConfiguration.java +++ /dev/null @@ -1,66 +0,0 @@ - -package udmi.schema; - -import com.fasterxml.jackson.annotation.JsonInclude; -import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonPropertyDescription; -import com.fasterxml.jackson.annotation.JsonPropertyOrder; - - -/** - * Bridge Pod Configuration - *

- * Parameters to define a bridge between message domains - * - */ -@JsonInclude(JsonInclude.Include.NON_NULL) -@JsonPropertyOrder({ - "enabled", - "from", - "morf" -}) -public class BridgePodConfiguration { - - @JsonProperty("enabled") - public String enabled; - /** - * Endpoint Configuration - *

- * Parameters to define a message endpoint - * - */ - @JsonProperty("from") - @JsonPropertyDescription("Parameters to define a message endpoint") - public EndpointConfiguration from; - /** - * Endpoint Configuration - *

- * Parameters to define a message endpoint - * - */ - @JsonProperty("morf") - @JsonPropertyDescription("Parameters to define a message endpoint") - public EndpointConfiguration morf; - - @Override - public int hashCode() { - int result = 1; - result = ((result* 31)+((this.morf == null)? 0 :this.morf.hashCode())); - result = ((result* 31)+((this.enabled == null)? 0 :this.enabled.hashCode())); - result = ((result* 31)+((this.from == null)? 0 :this.from.hashCode())); - return result; - } - - @Override - public boolean equals(Object other) { - if (other == this) { - return true; - } - if ((other instanceof BridgePodConfiguration) == false) { - return false; - } - BridgePodConfiguration rhs = ((BridgePodConfiguration) other); - return ((((this.morf == rhs.morf)||((this.morf!= null)&&this.morf.equals(rhs.morf)))&&((this.enabled == rhs.enabled)||((this.enabled!= null)&&this.enabled.equals(rhs.enabled))))&&((this.from == rhs.from)||((this.from!= null)&&this.from.equals(rhs.from)))); - } - -} diff --git a/bin/gencode b/bin/gencode index ef89e62b0f..c309e15161 100755 --- a/bin/gencode +++ b/bin/gencode @@ -20,11 +20,11 @@ venv_pip3=$(bin/which_venv_pip3) $venv_pip3 --version $venv_pip3 freeze > $tmpfile -#if ! diff $tmpfile etc/requirements.txt; then -# echo venv sanity check failed: diff \$\($venv_pip3 freeze\) etc/requirements.txt -# echo please run bin/setup_base -# false -#fi +if ! diff $tmpfile etc/requirements.txt; then + echo venv sanity check failed: diff \$\($venv_pip3 freeze\) etc/requirements.txt + echo please run bin/setup_base + false +fi bin/gencode_java bin/gencode_python @@ -34,9 +34,6 @@ if [[ -n $check ]]; then echo Checking gencode docs links... bin/gencode_docs_checklinks - echo Diff that one file... - diff BridgePodConfiguration.java gencode/java/udmi/schema/BridgePodConfiguration.java - files=`find gencode/ -type f | sort` sha256sum $files > /tmp/gencode.hash echo Checking gencode hash: diff /tmp/gencode.hash .gencode_hash.txt