From 8b794aacd15a7689f2d19aa4b74388d1c5829b28 Mon Sep 17 00:00:00 2001 From: Daley Plute Date: Mon, 27 Apr 2026 09:45:29 -0700 Subject: [PATCH] Replace placeholder alarm schema --- .gencode_hash.txt | 80 +- docs/messages/alarmset.md | 63 +- docs/messages/event.md | 2 +- docs/messages/readme.md | 4 +- docs/specs/categories.md | 3 + gencode/docs/commands_mapping.html | 89 +- gencode/docs/config.html | 701 +- gencode/docs/configuration_execution.html | 110 +- gencode/docs/events.html | 2160 +- gencode/docs/events_alarmset.html | 555 +- gencode/docs/events_discovery.html | 1947 +- gencode/docs/events_mapping.html | 91 +- gencode/docs/events_system.html | 96 +- gencode/docs/events_udmi.html | 96 +- gencode/docs/events_validation.html | 185 +- gencode/docs/metadata.html | 20713 +++++++--------- gencode/docs/monitoring.html | 110 +- gencode/docs/readme.md | 2 +- gencode/docs/state.html | 2483 +- gencode/docs/state_mapping.html | 103 +- gencode/docs/state_validation.html | 688 +- .../udmi/schema/AlarmAcknowledgement.java | 69 + .../java/udmi/schema/AlarmAlarmsetConfig.java | 51 +- .../java/udmi/schema/AlarmAlarmsetEvents.java | 60 +- .../java/udmi/schema/AlarmAlarmsetModel.java | 248 +- .../java/udmi/schema/AlarmAlarmsetState.java | 79 +- .../java/udmi/schema/AlarmRefDiscovery.java | 112 + gencode/java/udmi/schema/AlarmsetConfig.java | 52 +- gencode/java/udmi/schema/AlarmsetEvents.java | 27 +- gencode/java/udmi/schema/AlarmsetModel.java | 32 +- gencode/java/udmi/schema/AlarmsetState.java | 16 +- gencode/java/udmi/schema/Category.java | 6 + gencode/java/udmi/schema/Config.java | 2 +- gencode/java/udmi/schema/DiscoveryConfig.java | 15 +- gencode/java/udmi/schema/DiscoveryEvents.java | 20 +- .../java/udmi/schema/FamilyLocalnetModel.java | 2 +- gencode/java/udmi/schema/LocalnetConfig.java | 2 +- gencode/java/udmi/schema/Metadata.java | 4 +- .../java/udmi/schema/PointPointsetModel.java | 2 +- gencode/java/udmi/schema/State.java | 2 +- gencode/presentation/presentation.json | 20 - gencode/python/udmi/schema/__init__.py | 2 + gencode/python/udmi/schema/alarm_ack.py | 20 + gencode/python/udmi/schema/category.py | 3 + gencode/python/udmi/schema/config_alarmset.py | 4 - .../udmi/schema/config_alarmset_alarm.py | 6 +- .../python/udmi/schema/config_discovery.py | 1 + .../python/udmi/schema/discovery_alarm_ref.py | 25 + gencode/python/udmi/schema/events_alarmset.py | 3 +- .../udmi/schema/events_alarmset_alarm.py | 9 +- .../python/udmi/schema/events_discovery.py | 4 + gencode/python/udmi/schema/model_alarmset.py | 3 - .../udmi/schema/model_alarmset_alarm.py | 49 +- .../udmi/schema/state_alarmset_alarm.py | 16 - misc/bambi/presentation.gld.json | 20 - schema/alarm_ack.json | 26 + schema/category.json | 1 + schema/config_alarmset.json | 25 +- schema/config_alarmset_alarm.json | 27 +- schema/config_discovery.json | 4 + schema/discovery_alarm_ref.json | 43 + schema/events_alarmset.json | 8 +- schema/events_alarmset_alarm.json | 32 +- schema/events_discovery.json | 20 + schema/model_alarmset.json | 27 - schema/model_alarmset_alarm.json | 91 +- schema/state_alarmset_alarm.json | 15 - 67 files changed, 16690 insertions(+), 14896 deletions(-) create mode 100644 gencode/java/udmi/schema/AlarmAcknowledgement.java create mode 100644 gencode/java/udmi/schema/AlarmRefDiscovery.java create mode 100644 gencode/python/udmi/schema/alarm_ack.py create mode 100644 gencode/python/udmi/schema/discovery_alarm_ref.py create mode 100644 schema/alarm_ack.json create mode 100644 schema/discovery_alarm_ref.json diff --git a/.gencode_hash.txt b/.gencode_hash.txt index fe83115014..dab91ee172 100644 --- a/.gencode_hash.txt +++ b/.gencode_hash.txt @@ -1,40 +1,42 @@ 5c70161462ba15e3fd390ee725a721d35e95fa675e225fb30a605b5399b5a36e gencode/docs/building_config_entity.html c21266e8de23b6e8acfac16a177db782375bf71df470c343c3f8eb8b822ef56a gencode/docs/commands_discovery.html -7bd462fd9b31a1a35b27f069194051161c484600161d7ef3fa7a4f8efa4e65fb gencode/docs/commands_mapping.html -a65e8177ca59cd51c4a8ff63ecaa194897f7e22b82afb14708d63efbd7b96a84 gencode/docs/config.html +747f620450810aae5290fa00b1fb4bc1a4fbb673f9452f9a456a1c0a8858c97b gencode/docs/commands_mapping.html +e67ab6bce297527c0f5735e3636f5b62d3110620d1fcec76f02310016e97ca94 gencode/docs/config.html 0bb798c8db6be37266946569a096e2f0b7520ee54d65e7e8d37675ef17820f14 gencode/docs/configuration_endpoint.html -7caf6f29bff7c358536444c0d8502169f708bcc6f32a3d0a8aae155708b2cd04 gencode/docs/configuration_execution.html +59dcad204de75e8c2c5d04d0b7d23581bde438b73daa703676e61ece6c94ad3b gencode/docs/configuration_execution.html 11b21f73b6a4065102968a4c09979639b8a7ea6efb20e40d52cd21b2a60167bb gencode/docs/configuration_pod.html b34c136cee32cb88f32a427ff400c3898ed49168f6dcaca1bc9ba65365bc5ae4 gencode/docs/configuration_pubber.html 1057fa40fb7a31a23bb2773d21c38cf4590a935bd8b5ea4218e695c6204f5dd9 gencode/docs/data_template.html -ea06d489d98f96f8ac0134388fb4172b1fca6d924aba895c6e3119c19b0c7dc0 gencode/docs/events.html -70e57ad6ef39330d958727ebf9dcd61ef6ea30e4c8653eac412bf1867fdb3a70 gencode/docs/events_alarmset.html -feb4138c5acee9b3626e9c2e541711cec304c0e67c2999e6d713ee2e7144ef53 gencode/docs/events_discovery.html -808ad1cad37e9f4bf08ea3631162a663998ce60fe8935cbd0ca5e548c3b6df2a gencode/docs/events_mapping.html +60a4c61dd87c392249efe9fce51563bd8437e23c194d6b5c1dd9199dd1a7199e gencode/docs/events.html +ba25b58fe067e9725ff8f76f8c50ddabfd5b3d1404217a11fb2c95f048ab3043 gencode/docs/events_alarmset.html +ebdc99f24255ee86f47bea6b8b20fcb51a77a12c6711048443bf24b3ce1b9545 gencode/docs/events_discovery.html +12f3c21aced6c4edb3ff2e82939f6eac097b8bcb35afd46c6551fe57b899cf40 gencode/docs/events_mapping.html eafcc3c48189f605f114cde051fea9d13fc5f1a3e395d64fb0a91cb53d4c9aeb gencode/docs/events_pointset.html -cac253f57c5c92ef32e2a5f91b6cec8229e8db1dcffcc96a58f06da068e741e7 gencode/docs/events_system.html -151c1b62db35e84e51d5ff2a7464f61ced4d7fb0c7eb795715c245ee0a1b3436 gencode/docs/events_udmi.html -73dbe799e7943ec20ac58b544998e986a39539d4ef0cb4f5023e92e7634d3124 gencode/docs/events_validation.html -0af72961d68e952c511f3edff1fb9d7c94ba1aadfa31fbe89128f8dae7f9703c gencode/docs/metadata.html -c86682715d348bd3dd971fa5bd925a8a3d0f3c2944c65a47c4b64fe1a5ccdea2 gencode/docs/monitoring.html +26c11cb7d35860d53f5b39d0be366b7d8b040f3eef6d0e112bec889d85d7a657 gencode/docs/events_system.html +d70699581ba77ad07b21c1486764e3f110658c4a2ca09b3b8dde4a8c2efa1e7c gencode/docs/events_udmi.html +9255bf37a5c1c187ef7fa96ae95e24df44f60195a55580beb79f13d1a9a31ed5 gencode/docs/events_validation.html +56f781410b3802221a6284103ba3be06d8009d8c990d96fc085e5b9dd9f372c9 gencode/docs/metadata.html +dfa38fc5029f7450e4e5afc64495fa4c66f90cd7ca3f49b1affd2e7f4cf94395 gencode/docs/monitoring.html 474ca16edc9f3cad2bb3ab40b6993cbced90263f762f66ee6cd246a6c4a0d18f gencode/docs/persistent_device.html e11595fd11477947a27461f8ef4fb6facb5f60e2abd6212193f7581ab123ff84 gencode/docs/properties.html c006d0f46c8f007caa90ac76c713cead907669c14c09f4a288fac5b25afe05dd gencode/docs/query_cloud.html -6f2cd8163a129667beb79f297f193ecd14d40c4f1ac06570db13d912ab98fd3f gencode/docs/readme.md +b63213a898cd1dabf8484a355b3a38cb1f6cd3ff216d80ea4630c26b51a5c4db gencode/docs/readme.md 2768fd01a875d1f58273e76fef9b421986824d2ab02251853840bca777b625c0 gencode/docs/schema_doc.css 165a29291d7d66653e46fd1ac5868f63e18f9d67c06ea9ebcb95d4830a528e68 gencode/docs/schema_doc.min.js 7ed934930aee763e0beebc349725ba3909115e8d346bb762f28bcbe745bb163a gencode/docs/schema_extras.js 7a1bbe014c739078d354ec484147325e1d0bd19468f275a53da38add43ebe089 gencode/docs/site_metadata.html -95b953e99a5f202bf3f4348a48d9db62acd4ee9406523a37dcb230513026c4dd gencode/docs/state.html -a47043c68388aa21f5c906e9aa773ed3defb9239771d604153d5d4006e0e4fb9 gencode/docs/state_mapping.html -0b18cfdc1e87e61e696f35d9edd11ffec19dac82260e6f33e8c154dc676f5cc8 gencode/docs/state_validation.html -17803b0912ffdf0759564572dc98875a89e866d01801025ca01b0e9a21b7b7e4 gencode/java/udmi/schema/AlarmAlarmsetConfig.java -d2ef5bfa9f149d18e71a7767f5790cb6ff8ae2739aedd5a6dbf3113e56b62b12 gencode/java/udmi/schema/AlarmAlarmsetEvents.java -c3f989ff5f5f7a3c5c7ef0e94c6ac524ae61850ce37b0fbaa4e930a65aa2bb09 gencode/java/udmi/schema/AlarmAlarmsetModel.java -52c4ce4436261a8b4d5d50be1e27b0ebac5640891ce28dc655c59df4ef2b0fa2 gencode/java/udmi/schema/AlarmAlarmsetState.java -08759b0e33f090432319b2b9562480d595ce1ae06b069c54342d40a076f33e92 gencode/java/udmi/schema/AlarmsetConfig.java -9ff26a6b5c981dd59f0fac5ea32d79be94b8696de2b6c7ed183ba13c5c497ce1 gencode/java/udmi/schema/AlarmsetEvents.java -22d9d2cd4dac914634ad38d1bdf72b8f7a4504ec4e876db03ef2550cc8e9c881 gencode/java/udmi/schema/AlarmsetModel.java +1a0fc835b0056de1f1bc32704c9f716c5fcbdaab8d83d0083797e6778bc6c3b4 gencode/docs/state.html +ce68fc6c766a784e249d9e431801d21f2b793eb7f8ee7b41160df45b751c8114 gencode/docs/state_mapping.html +ee2db6e2d7c4b85374699461508e0afa45b016d4d739e05356dd11bd1b77260c gencode/docs/state_validation.html +560e98d1023b3d4675c588f315c566b88418a85e308e1d2a2ecea7b485321dea gencode/java/udmi/schema/AlarmAcknowledgement.java +b4a5c263e2fceba3dd8414f5ca17e329c3ed5a5901643d81756f06e8f5ad9d95 gencode/java/udmi/schema/AlarmAlarmsetConfig.java +70f577021407e6d18c6e6fa0a3a8e1f6dcaad1b4f1a67b34a35b5580053c580a gencode/java/udmi/schema/AlarmAlarmsetEvents.java +0689dc1e9173346047af30cf00787163a460b61453e2c1335fed14c033b2cf8c gencode/java/udmi/schema/AlarmAlarmsetModel.java +9067359121f888df318a5a379e6e271d9e27db8e9964ee0e1183c5018bbcff1a gencode/java/udmi/schema/AlarmAlarmsetState.java +704bbe5727f49b28f249f1ce82e2c57944e249428d4472e15933dca9518c5801 gencode/java/udmi/schema/AlarmRefDiscovery.java +fea998bd9a7a7b13b40a90cfb169e373f3f9d5c40ec3efaa83dd28e8801f714c gencode/java/udmi/schema/AlarmsetConfig.java +99958cf4077ff5b62290b0b93fcf229e5a170612591c4a82cb89a2f3d2f184e7 gencode/java/udmi/schema/AlarmsetEvents.java +ce4220ecf3f5fb75b7af75164be4443fc0b7eb265e59808a919debfa62b1dd50 gencode/java/udmi/schema/AlarmsetModel.java a1f0db9085fba8ecbeec48298bc00fb5f9460d8280a97b329ba7fd41bcde49ea gencode/java/udmi/schema/AlarmsetState.java 0e0d87fa6bc2f746eaacfbcd0f1258c9c6beee2b03d995868af9aafcbc4a88dc gencode/java/udmi/schema/Area.java 768d8b010bc90c5fbe198daf58f3847247ecc620a6fc046fffba877399cf1888 gencode/java/udmi/schema/Asset.java @@ -50,7 +52,7 @@ fa94295bc0c97518634c7232e7e55e1c923d7eb42bfa3004651ed183e1ccbb40 gencode/java/u 8773da8131fdc0f9409df0c04132abdaa01f658d0ec0e73dd8aa714b24454bdc gencode/java/udmi/schema/BuildingConfigEntity.java 519ead2ee2fe3e6fe48547266dec9a545521d52d262646f261ebfbbf8500d25f gencode/java/udmi/schema/BuildingTranslation.java 27ca4f61bd43beca0871b465f3906785a1030a4526605f1fa9b10e3adda8df05 gencode/java/udmi/schema/CapabilityValidationState.java -224c6be2cb6d90a47d181fa30ba1418cf6cc5385ec1c010fe112728382a70216 gencode/java/udmi/schema/Category.java +f38892a9af24b046c055204858183039b05c3bbd5a9707363c31fddb8703e98c gencode/java/udmi/schema/Category.java 0101d742dbaa23fb2152b044e5eabd6d219047cddbb973e9626a026946b7ddfc gencode/java/udmi/schema/CloudModel.java 051b4a7c85a2f1a310787f88f336be2fc9b87c99a94ac2f970955d2fe1daa931 gencode/java/udmi/schema/CloudQuery.java 3e6572b16184bde7557eb67334405e7c5b58446e64802658cf0d5ef3b0018909 gencode/java/udmi/schema/Common.java @@ -65,8 +67,8 @@ 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 -ff98f706c967bbef7be35d826f5abad822c89d2fa981c4d8e6cffbb106d3740c gencode/java/udmi/schema/DiscoveryConfig.java -752faf5921575c895cf984e136effd0dc4837f095c66c26dd0c54fcd31b4a486 gencode/java/udmi/schema/DiscoveryEvents.java +4c27c01700aa1cb217b9dda680c8d2fdfabc7cead1029c6d867c6092f0f631c7 gencode/java/udmi/schema/DiscoveryConfig.java +046b9b57b11d529daead15cb7dc4f74265e5c4d88cbb8fb91b1043d63d9dee88 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 @@ -157,25 +159,26 @@ a671f5341703d03200c3a4b4df41f109e587e3723292321998595da60b03e4a2 gencode/java/u 8cc9c88554fc6c9d7d6eba6884279eab3160b4e72d8edfef8155e69ec61c1eec gencode/java/udmi/schema/ValidationState.java eadc72e31b4796273479967303513b16563af0f946d1e1c7eba1748f9b133d40 gencode/java/udmi/schema/ValidationSummary.java 11f8dab5296d41e86cd623a4ed27b972ae673b141907cb913397d4eb53880c59 gencode/java/udmi/schema/Water.java -f6e74a51f453f1d198500ed77bd28b668c2317ba84ba93229db928cde55e0877 gencode/presentation/presentation.json +bbd72fee7464a85e62cf97c3d2f5dd1553fb77b3eb1db3483d9b1e57fe69df7e gencode/presentation/presentation.json 4cf98cbd132cde0cc8813ac35cf3712cb46014154c817c04ad2902c268cdd8fe gencode/python/pyproject.toml -a98b84029d33a421872a08f7bfb1bd2f23f8dc3bebc8d7a1c2a7f1c8596510bf gencode/python/udmi/schema/__init__.py +da5dc140af8b30af5cd30d95a45a66a79a538d005d4af18c1471fe348b969f6e gencode/python/udmi/schema/__init__.py f9d90861e568b27445bef241f04cce64cc44731c95c8bd9e3f65cef79d42dab0 gencode/python/udmi/schema/_base.py 0e18050ec17fde8162f75a76d9dc623d3f6ddca4396441bd603189827ed21a80 gencode/python/udmi/schema/access_iot.py +e7f96f985e8c28c81b312bfb11b1dc63a6067dad7570d1d0a8f6770a4a386651 gencode/python/udmi/schema/alarm_ack.py 32a951e2bf13f556082f8d94be079b3df6cc081b6ff59f71a82d32782cf8f8f6 gencode/python/udmi/schema/ancillary_properties.py 9f27d0a731ced4b83c9769661fed2656814983394532aac9e2a97c71dd185e2a gencode/python/udmi/schema/bucket.py b4f4a394ce4049fafe267a146458d5b1725e2532788c5811b4b0b96f84715e31 gencode/python/udmi/schema/building_config_entity.py 6289f299f33104a14be1c67762c8bcb494c008d34a2ff906ef3760164538fc82 gencode/python/udmi/schema/building_translation.py -9839ac82da64c8ad1b9ae144fa6be9d819a68f8e22336403321cad9af0d0033f gencode/python/udmi/schema/category.py +bdd5e251b668e7ccb183982f27b8afa4692a900705735b727e92cc86ad75be35 gencode/python/udmi/schema/category.py e92d040fe84cc1bbc6e6b2d81a39dae156e1501e1c07a0b6cfc42e1599403e64 gencode/python/udmi/schema/commands_discovery.py 8468bc35ad108e4618555cab711bdee700b64780e0d8c18f641c6a0ed21e2338 gencode/python/udmi/schema/commands_mapping.py 9e15cea83255f018e6e85fdbf8051211561c10ea34caa926a21eb140de31d82c gencode/python/udmi/schema/common.py 59639574385a4eb18b85f8b545b69b066a45f868c4645bdaf5a87ad572772b78 gencode/python/udmi/schema/config.py -9f70f080bff148c1d31707e7f6f023ed558f738fa4db8ad3f4b71868d43fbf6a gencode/python/udmi/schema/config_alarmset.py -77c940663e59bd14bcfad0b6b83aaded3339ce032a2ef5764717c3d78b485880 gencode/python/udmi/schema/config_alarmset_alarm.py +2c54032fa806d8254064e0b57305ed5ab476f21f9b37794fb9b2707cd90494b7 gencode/python/udmi/schema/config_alarmset.py +e2e9c152945b26234facbe9e0b2f57ce517fd63d45ec31ec5a9652afaf551e0d gencode/python/udmi/schema/config_alarmset_alarm.py 0feda2aadb7b5cbfbadc1ea6950292f428b765f8f27e874414d3ca9941f3746c gencode/python/udmi/schema/config_blobset.py 234b237a299d31b92dd873af6713c56e388345faeb79cbf2b46090c7d10ef00a gencode/python/udmi/schema/config_blobset_blob.py -246f6878e5a4b7f5e1a27d1c51aadd42bef07ee2113b9cd568bb623b24bc85de gencode/python/udmi/schema/config_discovery.py +649e791dada332833328042f355119968328b66c3aaf4e1322cb0767ae6d00bf gencode/python/udmi/schema/config_discovery.py e76f7f4ef913000e2bb8599f7449283e976590f17883837d4329dae0e65a1f64 gencode/python/udmi/schema/config_discovery_family.py 0d100d1fec28c4e59cba704e5a512549972f427ea4da268c7472208fdccd96a6 gencode/python/udmi/schema/config_gateway.py 8119455e323f686da48ccf65d494d0dc2a26ad2a2a02d0f0167dc9a020740225 gencode/python/udmi/schema/config_localnet.py @@ -195,6 +198,7 @@ c0853ff1838a11291b53a40c43a6cdaff17951a34b3d7f3de10d9fcc7b44b79d gencode/python 55b171d45392a5bfdde5e0232df0582b04786101a6e3fe97b0ad446314f911cc gencode/python/udmi/schema/configuration_pubber.py 2d5fdc319dd0b631057c8de0656a4aa3dfae50e66949d41395f39dd12787fcb5 gencode/python/udmi/schema/data_template.py f7193dd8eddcae6c646b99fb4c33fe47f43bed7c9615ab1bd0a0bf5612527607 gencode/python/udmi/schema/dimension.py +14f185cb4cc559506b34023ebe95c07c333927a94e07757d8f4056c60a7a46fd gencode/python/udmi/schema/discovery_alarm_ref.py 1f9ee37d9fb03d3966303a94fdffc41e731759f1ed9f2dba0cbba8a687635af6 gencode/python/udmi/schema/discovery_family.py 86f262123525f2e6119c174fe4a4cd2f2c35863ced03a66f6db32c08e5a08542 gencode/python/udmi/schema/discovery_feature.py b978caf892bc6d0fb875b2560b81668cd1a47a09436609dc56d6353ef35b5f86 gencode/python/udmi/schema/discovery_ref.py @@ -202,9 +206,9 @@ be97796ac8949ccb7fbdecfb4ff087987cf2849bf223ff39b947771a08422156 gencode/python c16bc9abbf27178653d8f0b716805d02cbf01615b160880bbb33db3bacb9b480 gencode/python/udmi/schema/envelope.py 04f518ca330acb6f376838bdc4425f15582eb185f4b05f00fc76d1af92bac57f gencode/python/udmi/schema/equipment_translation.py 555d45b8882e31095e7233bfffbade89840535aff33dbe20cd24e6808b6205a3 gencode/python/udmi/schema/events.py -af48a2d32b4ec326df6e3f165d8944b994fb426bd4e663c42c1d592f5cb41f83 gencode/python/udmi/schema/events_alarmset.py -b58371ffa7979d1598502a35859f3010ae7a2ec2d851454c010c835e426c7a14 gencode/python/udmi/schema/events_alarmset_alarm.py -3996175098735e889730c87ffc9ce1648e6624d801694458f6d4bc147ff29741 gencode/python/udmi/schema/events_discovery.py +ab299a219cca13359c95c99783b7e507c37bc8bdb60a75e04a7573ddfefc92fa gencode/python/udmi/schema/events_alarmset.py +a66704c9a2065497994edf2a4dfe16692e3ad5a430a4f604749649102511e1bc gencode/python/udmi/schema/events_alarmset_alarm.py +18da6b3efd9bbad21e3568423250ada1bd227e5bffba792b961e3907f56c5b99 gencode/python/udmi/schema/events_discovery.py ec7219393503df5ec63891b9c2c1370a5b1a7aa7e2f66af30bf25f3c91633574 gencode/python/udmi/schema/events_mapping.py b91028eaea497f3075a4cf7462edc909ec6e6c92cbc26ae411f6fb1028101573 gencode/python/udmi/schema/events_mapping_entities.py 3db1d884e1822b2838e39883731e8674953f23cfe84301ced8d95333c8c4551f gencode/python/udmi/schema/events_mapping_entity.py @@ -216,8 +220,8 @@ e4cdab07942e52cae243b4dddbc72676794914947dd66df8add0f5969f31fd11 gencode/python a3ea178f98a4993da708e2ec41f5ede74aa92d742ffbe201a77adef803d4143a gencode/python/udmi/schema/events_validation_device.py 5660433b409bdaeacdce6b128660914586cca434e5373b3f94c04e89952642b4 gencode/python/udmi/schema/level.py 9577d11c5110af169aafd0e083d115c849ce17dfdc2b6b23b7186c69c1c333db gencode/python/udmi/schema/metadata.py -cd81df64d7db21ab06f84cdbd07a808a641612c7c1124f9f2d928a898c3c767e gencode/python/udmi/schema/model_alarmset.py -b80b7f580fd7527da0c2caff063218488cf5bbd091daa64a6a5f9a5d45b135c2 gencode/python/udmi/schema/model_alarmset_alarm.py +e4ef7b6e464dd5b8cd79838b2b42a9a462d059da60f7427aff692a9b727cc2d0 gencode/python/udmi/schema/model_alarmset.py +6023c116175a350f6a354da69178c361823014301e492f4fba53e233f9dd8ee8 gencode/python/udmi/schema/model_alarmset_alarm.py bb3e28f8ae3b43ddd3b99fbc96a2a3cfd7103e0742fb9427c2191b3674ccea90 gencode/python/udmi/schema/model_cloud.py 670ea1a72ade3d9af0df00c694cbd755f3a2748022c99b90f3b86a017b7424a9 gencode/python/udmi/schema/model_cloud_config.py 798ee0ee5094d1c3e4681626832d16428df26e752e0e0425d61178f6e231efa6 gencode/python/udmi/schema/model_discovery.py @@ -246,7 +250,7 @@ debb60af8af183f2382f6def95a7a3d051c8b34d68de094e76e7d8636532c3d2 gencode/python 0de84447d111ff725e63308cfcef7789c3f01060444b70d49d97088f10d0e82f gencode/python/udmi/schema/site_metadata.py 9d068b1d74c0a8a8b1906981d6637e61f019408ca2fdd54ff98b592464918bd7 gencode/python/udmi/schema/state.py b7716237e19b93ee7e56b55d42f965e4fa9295a3be7352f70108f208b1d58d8d gencode/python/udmi/schema/state_alarmset.py -bc7fae9084e9511001e87409867ea5c1edd29892b21cd611d7d3689afa39ed68 gencode/python/udmi/schema/state_alarmset_alarm.py +99e7ddb672c8b8ba096308f23daa76ad00dce6e28a03a94811b00fad384f29ac gencode/python/udmi/schema/state_alarmset_alarm.py c3aafb1bcd85fc43f50aaba1f30f51657108d70ef62ffd95444112be508973bb gencode/python/udmi/schema/state_blobset.py a3b9848f8887b75e013276ebd353afad899f147bec7c1ea0d70d7833f5dbe212 gencode/python/udmi/schema/state_blobset_blob.py 450d9ef8aca6ac904a8231ab4b0d1c268f0f5d24693fd4757664bb4c71e4a7f6 gencode/python/udmi/schema/state_discovery.py diff --git a/docs/messages/alarmset.md b/docs/messages/alarmset.md index 870c5a35ba..d4c6d25a61 100644 --- a/docs/messages/alarmset.md +++ b/docs/messages/alarmset.md @@ -4,9 +4,9 @@ # Alarmset Specification -A `alarmset` represents a set of alarms reporting telemetry data. This is the most common data, and should be stored in an appropriate time-series database. +An `alarmset` represents a set of alarms reporting state change events. -Specific `alarm_names` within a `alarmset` should be specified in _snake_case_ and adhere to the +Specific `alarm_names` within an `alarmset` should be specified in _snake_case_ and adhere to the data ontology for the device (stipulated and verified outside of UDMI, e.g. [Digital Buildings Ontology](https://github.com/google/digitalbuildings/tree/master/ontology)). @@ -24,13 +24,12 @@ Alarmset is represented in four locations: The `metadata.alarmset` subblock represents the abstract system expectation for what the device _should_ be doing, and how it _should_ be configured and operated. This block specifies the -expected alarms that a device holds, along with, if the field is numeric, the expected units of those alarms. -The general structure of a `alarmset` block exists inside of a complete metadata message +expected alarms that a device holds. +The general structure of an `alarmset` block exists inside of a complete metadata message * `alarmset`: Top level block designator. * `alarms`: Collection of alarm names. * _{`alarm_name`}_: Alarm name. - * `units`: Expected units designation for this alarm. ## Event @@ -38,29 +37,20 @@ The general structure of a `alarmset` block exists inside of a complete metadata ([_🧬View_](../../gencode/docs/events_alarmset.html#alarms)) - [Working `events_alarmset` Example](../../tests/schemas/events_alarmset/example.json) -A basic `alarmset` event message contains -the alarm data sent from a device. The message contains just the top-level `alarms` designator, -while the `alarmset` typing is applied as part of the [message envelope](envelope.md). +A basic `alarmset` event message contains the alarm data sent from a device. The message contains +just the top-level `alarms` designator, while the `alarmset` typing is applied as part of the +[message envelope](envelope.md). * `alarms`: Collection of alarm names. * _{`alarm_name`}_: Alarm name. - * `present_value`: The specific alarm data reading. If the value represents a number, then this must be serialized as a JSON number, not a quoted string. -* `partial_update`: Optional indicator if this is an incremental update (not all alarms included). + * `active`: Boolean indicating whether or not the alarm is currently active. + * `activate_time`: The timestamp of when the alarm most recently became active. + * `activate_ack`: Optional details about acknowledgement of the alarm activation. + * `return_to_normal_time`: Optional timestamp of when the alarm deactivated. + * `return_to_normal_ack`: Optional details about acknowledgement of the alarm returning to normal. -Event telemetry messages should be sent "as needed" or according to specific requirements as -stipulated in the `config` block. The basic `alarmset` event message for a device should -contain the values for all representative alarms from that device, as determined by the associated -`config` block. If no alarms are specified in the `config` block, the device programming determines -the representative alarms. - -### Incremental Updates and CoV - -Incremental updates (e.g. for COV) can send only the specific updated alarms as an optimization, -while setting the top-level -[🧬`partial_update`](../../gencode/docs/events_alarmset.html#partial_update) field to `true` These -messages may be indiscriminately dropped by the backend systems, so a periodic full-update must -still be sent (as per `sample_rate_sec` below). Sending an update where all expected alarms are not -included, without this flag, is considered a validation error. +Alarm event messages should be sent when a configured alarm activates, returns to normal, or is +acknowledged. ## State @@ -68,45 +58,30 @@ included, without this flag, is considered a validation error. ([_🧬View interactive_](../../gencode/docs/state.html#alarmset)) - [Working `state` Example](../../tests/schemas/state/example.json) -The [state](state.md) message from a device contains a `alarmset` block with the following +The [state](state.md) message from a device contains an `alarmset` block with the following structure: * `alarmset`: Top level block designator. * `alarms`: Collection of alarm names. * _{`alarm_name`}_: Alarm name. * (`status`): Optional [status](status.md) information about this alarm. - * (`value_state`): Optional enumeration indicating the - [state of the alarms value.](../specs/sequences/writeback.md#value_state) - -In all cases, the alarms `status` field can be used to supply more information (e.g., the -reason for an _invalid_ or _failure_ `value_state`). ## Config - [🧬Schema](../../gencode/docs/config.html#alarmset) -- [Working `config` Example](../../tests/schemas/config/writeback.json) -The [config](config.md) message for a device contains a `alarmset` -block with the following structure:e +The [config](config.md) message for a device contains an `alarmset` +block with the following structure: * `alarmset`: Top level block designator. - * `sample_rate_sec`: Maximum time between samples for the device to send out a _complete_ - update. It can send out updates more frequently than this. - * `sample_limit_sec`: Minimum time between sample updates for the device (including complete - and COV updates). Updates more frequent than this should be coalesced into one update. * `alarms`: Collection of alarm names, defining the representative alarm set for this device. * _{`alarm_name`}_: Alarm name. - * `units`: Set as-operating units for this alarm. - * (`set_value`): Optional setting to control the specified device alarm. If the set_value represents a number, then this must be serialized as a JSON number, not a quoted string. See [writeback documentation](../specs/sequences/writeback.md). - * (`cov_threshold`): Optional threshold for triggering a COV event update. + * `ref`: Reference name of the alarm's internal counterpart. The alarms defined in the `config.alarmset.alarms` dictionary is the authoritative source indicating the representative alarms for the device (in both `event` and `state` messages). If the device has additional alarms that are _not_ stipulated in the config they should be silently dropped. If the device does not know about a stipulated alarm then it should report it as a alarm with an _error_ level `status` entry in its `state` message, and exclude it from the event message. -If a `config` block is not present, or does not contain a `alarmset.alarms` object, +If a `config` block is not present, or does not contain an `alarmset.alarms` object, then the device should determine on its own which alarms to report. - -If `sample_rate_sec` is not defined (or zero), then the system is expected to send an update at least every -300 seconds (5 minutes as a default value). A negative value would mean "don't send updates." diff --git a/docs/messages/event.md b/docs/messages/event.md index 39d39d962c..1f4e5dbe24 100644 --- a/docs/messages/event.md +++ b/docs/messages/event.md @@ -4,7 +4,7 @@ Events can be one of: - [Pointset (telemetry)](pointset.md#telemetry) ([_🧬schema_](../../gencode/docs/events_pointset.html)) -- [Alarmset (telemetry)](alarmset.md#telemetry) ([_🧬schema_](../../gencode/docs/events_alarmset.html)) +- [Alarmset](alarmset.md) ([_🧬schema_](../../gencode/docs/events_alarmset.html)) - [System (logging, etc)](system.md#event) ([_🧬schema_](../../gencode/docs/events_system.html)) - [Discovery](../specs/discovery.md) ([_🧬schema_](../../gencode/docs/events_discovery.html)) diff --git a/docs/messages/readme.md b/docs/messages/readme.md index f1d2bf0411..a81324ae2c 100644 --- a/docs/messages/readme.md +++ b/docs/messages/readme.md @@ -11,7 +11,7 @@ Each message has an associated sub block (sometimes called a _subFolder_) that i scoping of the message or block: - [pointset](pointset.md) messages deal with data point telemetry (e.g. temperature reading) -- [alarmset](alarmset.md) messages deal with alarm point telemetry +- [alarmset](alarmset.md) messages deal with alarms - [system](system.md) messages handle system events such as rebooting, config processing, firmware, etc... ## Message Types @@ -52,7 +52,7 @@ See the individual block folder documentation to learn more about those aspects. - [state](state.md) ([_🧬schema_](../../gencode/docs/config.html)) - [event](event.md) - [Pointset (telemetry)](pointset.md#telemetry) ([_🧬schema_](../../gencode/docs/events_pointset.html)) - - [Alarmset (telemetry)](alarmset.md#telemetry) ([_🧬schema_](../../gencode/docs/events_alarmset.html)) + - [Alarmset](alarmset.md) ([_🧬schema_](../../gencode/docs/events_alarmset.html)) - [System (logging, etc)](system.md) ([_🧬schema_](../../gencode/docs/events_system.html)) - [Discovery](../specs/discovery.md) ([_🧬schema_](../../gencode/docs/events_discovery.html)) - [envelope](envelope.md) diff --git a/docs/specs/categories.md b/docs/specs/categories.md index 3f43828c7d..43fc27aa8f 100644 --- a/docs/specs/categories.md +++ b/docs/specs/categories.md @@ -35,6 +35,9 @@ could be used with a **WARNING** level for a warning case during normal operatio * _overridden_: (**WARNING**) The reported value has been overridden locally * _failure_: (**ERROR**) The system failed to read/write the point * _invalid_: (**ERROR**) A `config` parameter for the point is invalid in some way +* _alarmset_: Handling alarm configuration + * _alarm_: Conditions specific to an individual alarm + * _invalid_: (**ERROR**) A `config` parameter for the alarm is invalid in some way * _localnet_: Aspects of working with various local networks * _network_: (**INFO**) Aspects of a specific network * _connect_: (**NOTICE**) Connected status of the device on diff --git a/gencode/docs/commands_mapping.html b/gencode/docs/commands_mapping.html index 66bd215042..883c7a2bca 100644 --- a/gencode/docs/commands_mapping.html +++ b/gencode/docs/commands_mapping.html @@ -504,6 +504,11 @@

id="status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_status_category_oneOf_i36" role="tab" onclick="setAnchor('#status_category_oneOf_i36')" >Option 37 +
@@ -1138,7 +1143,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1178,7 +1183,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1218,7 +1223,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1258,7 +1263,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1298,7 +1303,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1338,7 +1343,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1378,7 +1383,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1418,7 +1423,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1458,7 +1463,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1498,7 +1503,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1538,7 +1543,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1578,7 +1583,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1618,7 +1623,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1658,7 +1663,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1698,7 +1703,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -1738,7 +1743,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -1778,7 +1783,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -1818,7 +1823,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -1858,7 +1863,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -1898,7 +1903,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -1938,7 +1943,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -1978,7 +1983,47 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/config.html b/gencode/docs/config.html index 7a44b361d5..3127b6e48d 100644 --- a/gencode/docs/config.html +++ b/gencode/docs/config.html @@ -1184,10 +1184,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -2108,6 +2108,47 @@

Must be one of:

+ + + + +
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not to discover alarms.

+
+ + + + + +
@@ -2228,13 +2269,13 @@

Family Localnet Config

Family Localnet Config

Type: object
+ + + + - - - - - + @@ -2274,12 +2315,12 @@

networksType: object

Network address family config for reporting.

No Additional Properties + + + - - - - +
@@ -2323,13 +2364,13 @@

Family Localnet Config

Family Localnet Config

Type: object
+ + + + - - - - - +
@@ -2771,12 +2812,12 @@

No Additional Properties + + + - - - - +
@@ -2808,10 +2849,10 @@

timestamp

Type: stringFormat: date-time

RFC 3339 UTC timestamp the configuration was generated

+ - - - + +
Example:
@@ -2853,176 +2894,12 @@

version

Type: string

Version of the UDMI schema

+ + + - - - - -
- - - -
-
-
-

- -

-
- -
-
- - Type: string
-

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

-
- - - -

Must be at most 32 characters long

- - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: stringFormat: date-time
-

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

-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: 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

- - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: integer Default: 300
-

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

-
- - - -

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

- - +
@@ -3056,14 +2933,14 @@

/> alarms

Type: object
-

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

+

The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device. Alarmset doumentation

No Additional Properties + + + - - - - +
@@ -3108,12 +2985,12 @@

No Additional Properties + + + - - - - +
@@ -3157,426 +3034,14 @@

/> ref

Type: string
-

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

+

Mapping for the alarm to its internal counterpart

+ + + - - - -
-
Example:
-
"AI1106"
-
-
-
-
-

-
-
-
-
-

- -

-
- -
-
- - Type: string
-

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

-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- -
-

Used for cloud writeback functionality, this field specifies the value for a given alarm in the device's current units. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer

-

- -

-
- - - Type: string
- - - - - - - -
- - - Type: boolean
- - - - - - - -
- - - Type: number
- - - - - - - -
- - - - - -
-
Example:
-
22.4
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: stringFormat: date-time
-

RFC 3339 timestamp for the specified alarm write easing to stop

-
- - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: number
-

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

-
- - - -

Value must be greater or equal to 0

- - +
diff --git a/gencode/docs/configuration_execution.html b/gencode/docs/configuration_execution.html index facf8a4a4b..28bb38c0be 100644 --- a/gencode/docs/configuration_execution.html +++ b/gencode/docs/configuration_execution.html @@ -4465,6 +4465,11 @@

id="mapping_configuration_devices_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_mapping_configuration_devices_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#mapping_configuration_devices_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -5435,7 +5440,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -5496,7 +5501,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -5557,7 +5562,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -5618,7 +5623,7 @@

/> item 18

Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -5679,7 +5684,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -5740,7 +5745,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -5801,7 +5806,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -5862,7 +5867,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -5923,7 +5928,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -5984,7 +5989,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -6045,7 +6050,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -6106,7 +6111,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -6167,7 +6172,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -6228,7 +6233,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -6289,7 +6294,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -6350,7 +6355,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -6411,7 +6416,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -6472,7 +6477,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -6533,7 +6538,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -6594,7 +6599,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -6655,7 +6660,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -6716,7 +6721,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/events.html b/gencode/docs/events.html index b57d88a910..44dab1ec3c 100644 --- a/gencode/docs/events.html +++ b/gencode/docs/events.html @@ -650,6 +650,11 @@

id="system_logentries_items_category_oneOf_i36" data-toggle="tab" href="#tab-pane_system_logentries_items_category_oneOf_i36" role="tab" onclick="setAnchor('#system_logentries_items_category_oneOf_i36')" >Option 37 +
@@ -1508,7 +1513,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1562,7 +1567,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1616,7 +1621,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1670,7 +1675,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1724,7 +1729,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1778,7 +1783,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1832,7 +1837,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1886,7 +1891,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1940,7 +1945,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1994,7 +1999,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -2048,7 +2053,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -2102,7 +2107,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -2156,7 +2161,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -2210,7 +2215,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -2264,7 +2269,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2318,7 +2323,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2372,7 +2377,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2426,7 +2431,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2480,7 +2485,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2534,7 +2539,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2588,7 +2593,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -2642,7 +2647,61 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -4173,6 +4232,11 @@

id="discovery_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_discovery_status_category_oneOf_i36" role="tab" onclick="setAnchor('#discovery_status_category_oneOf_i36')" >Option 37 +
@@ -4919,7 +4983,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -4966,7 +5030,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -5013,7 +5077,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -5060,7 +5124,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -5107,7 +5171,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -5154,7 +5218,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -5201,7 +5265,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -5248,7 +5312,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -5295,7 +5359,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -5342,7 +5406,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -5389,7 +5453,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -5436,7 +5500,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -5483,7 +5547,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -5530,7 +5594,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -5577,7 +5641,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -5624,7 +5688,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -5671,7 +5735,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -5718,7 +5782,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -5765,7 +5829,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -5812,7 +5876,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -5859,7 +5923,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -5906,7 +5970,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -7464,10 +7575,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -9415,10 +9526,10 @@

network_idType: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -12528,6 +12639,11 @@

id="discovery_points_pattern1_structure_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_discovery_points_pattern1_structure_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#discovery_points_pattern1_structure_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -13722,7 +13838,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -13797,7 +13913,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -13872,7 +13988,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -13947,7 +14063,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -14022,7 +14138,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -14097,7 +14213,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -14172,7 +14288,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -14247,7 +14363,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -14322,7 +14438,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -14397,7 +14513,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -14472,7 +14588,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -14547,7 +14663,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -14622,7 +14738,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -14697,7 +14813,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -14772,7 +14888,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -14847,7 +14963,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -14922,7 +15038,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -14997,7 +15113,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -15072,7 +15188,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -15147,7 +15263,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -15222,7 +15338,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -15297,7 +15413,82 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -16409,10 +16600,10 @@

link

Type: string

Virtual equipment mapping linking this local point to a remote point in another device

Must match regular expression: ^[-0-9a-zA-Z$]+:[a-z0-9_]+$ + - - - + +
Example:
@@ -17427,6 +17618,11 @@

id="discovery_refs_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_discovery_refs_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#discovery_refs_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -18397,7 +18593,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -18458,7 +18654,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -18519,7 +18715,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -18580,7 +18776,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -18641,7 +18837,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -18702,7 +18898,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -18763,7 +18959,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -18824,7 +19020,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -18885,7 +19081,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -18946,7 +19142,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -19007,7 +19203,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -19068,7 +19264,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -19129,7 +19325,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -19190,7 +19386,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -19251,7 +19447,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -19312,7 +19508,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -19373,7 +19569,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -19434,7 +19630,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -19495,7 +19691,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -19556,7 +19752,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -19617,7 +19813,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -19678,7 +19874,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -20563,16 +20820,1709 @@

-
+
-
+

- +

-
+
+ + Type: object
+

Information about a specific alarm name of the device.

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
+ +

Alarm Alarmset Model

Type: object
+

Information about a specific alarm name of the device.

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Mapping for the alarm to its internal counterpart

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Collection of alarm information

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ +

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Friendly name for the reference, if known

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Collection of alarm references

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ +

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Friendly name for the reference, if known

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
@@ -21628,10 +23578,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
diff --git a/gencode/docs/events_alarmset.html b/gencode/docs/events_alarmset.html index 2a21d2398b..d939006d35 100644 --- a/gencode/docs/events_alarmset.html +++ b/gencode/docs/events_alarmset.html @@ -11,8 +11,8 @@ - - + + Alarmset Events
@@ -21,14 +21,14 @@

Alarmset Events

Type: object
-

A set of alarms reporting telemetry data. Alarmset Events Documentation

+

A set of alarm events.

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

/> timestamp

Type: stringFormat: date-time
-

RFC 3339 UTC timestamp the telemetry event was generated

+

RFC 3339 UTC timestamp the alarm event was generated

+ - - - + +
Example:
@@ -91,12 +91,12 @@

version

Type: string

Version of the UDMI schema

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

upgraded_from

Type: string

Original version of schema pre-upgrade

+ + + - - - - -
-
- - -
-
-
-

- -

-
- -
-
- - Type: boolean
-

Indicates if this is a partial update (only some alarms may be included)

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

alarms

Type: object

Collection of alarm names, defining the representative alarm set for this device.

No Additional Properties + + + - - - - +
@@ -237,24 +203,72 @@

No Additional Properties + + + + +
+
+
+

+ +

+
+
+
+ Type: stringFormat: date-time
+

Timestamp of when the alarm became active.

+
+ + + -
+ +
+
+
+
+
-
+

- +

-
+

-

The specific alarm data reading. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer

-

- -

-

Alarm Acknowledgement

Type: object
+

Acknowledgement of the alarm activation.

+
+ No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
Type: stringFormat: date-time
+

Timestamp of when the alarm was acknowledged.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
- + activate_ack + + + + user
Type: string
+

Name of the user who acknowledged this alarm.

+
+ + + + +
+
+
+
+
+
+
+

+ +

+
+
+
+ Type: string
+

Comment left by the user when acknowledging this alarm.

+
+ + + -
+ +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
Type: boolean
+

Indicates whether or not the alarm conditions are currently active.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+ return_to_normal_time
Type: stringFormat: date-time
+

Timestamp of when the alarm conditions returned to normal.

+
+ + + + +
+
+
+
+
+
+
+

+ +

+
+
+
+

Alarm Acknowledgement

Type: object
+

Acknowledgement of the alarm returning to normal.

+
+ No Additional Properties + + + -
+ +
+
+
+

+ +

+
+
+
Type: stringFormat: date-time
+

Timestamp of when the alarm was acknowledged.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: number
- - - - - - + Alarm Alarmset Events + + + + return_to_normal_ack + + + + user
Type: string
+

Name of the user who acknowledged this alarm.

+
+ -
+ + + +
+
+
+
+
+
+
+

+ +

+
+
+
+ Type: string
+

Comment left by the user when acknowledging this alarm.

+
+ + + -
-
Examples:
-
24.1
-
-
"running"
-
-
4
-
+ +
+
+
diff --git a/gencode/docs/events_discovery.html b/gencode/docs/events_discovery.html index 13567f9a9b..895b3cb41c 100644 --- a/gencode/docs/events_discovery.html +++ b/gencode/docs/events_discovery.html @@ -474,6 +474,11 @@

id="status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_status_category_oneOf_i36" role="tab" onclick="setAnchor('#status_category_oneOf_i36')" >Option 37 +
@@ -1108,7 +1113,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1148,7 +1153,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1188,7 +1193,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1228,7 +1233,7 @@

/> item 18

Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1268,7 +1273,7 @@

/> item 19

Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1308,7 +1313,7 @@

/> item 20

Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1348,7 +1353,7 @@

/> item 21

Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1388,7 +1393,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1428,7 +1433,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1468,7 +1473,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1508,7 +1513,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1548,7 +1553,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1588,7 +1593,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1628,7 +1633,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1668,7 +1673,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -1708,7 +1713,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -1748,7 +1753,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -1788,7 +1793,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -1828,7 +1833,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -1868,7 +1873,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -1908,7 +1913,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -1948,7 +1953,47 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -3317,10 +3362,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -5044,10 +5089,10 @@

network_idType: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -7821,6 +7866,11 @@

id="points_pattern1_structure_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_points_pattern1_structure_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#points_pattern1_structure_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -8903,7 +8953,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -8971,7 +9021,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -9039,7 +9089,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -9107,7 +9157,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -9175,7 +9225,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -9243,7 +9293,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -9311,7 +9361,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -9379,7 +9429,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -9447,7 +9497,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -9515,7 +9565,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -9583,7 +9633,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -9651,7 +9701,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -9719,7 +9769,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -9787,7 +9837,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -9855,7 +9905,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -9923,7 +9973,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -9991,7 +10041,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -10059,7 +10109,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -10127,7 +10177,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -10195,7 +10245,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -10263,7 +10313,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -10331,7 +10381,75 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -11345,10 +11463,10 @@

link

Type: string

Virtual equipment mapping linking this local point to a remote point in another device

Must match regular expression: ^[-0-9a-zA-Z$]+:[a-z0-9_]+$ + - - - + +
Example:
@@ -12258,6 +12376,11 @@

id="refs_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_refs_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#refs_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -13116,7 +13239,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -13170,7 +13293,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -13224,7 +13347,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -13278,7 +13401,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -13332,7 +13455,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -13386,7 +13509,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -13440,7 +13563,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -13494,7 +13617,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -13548,7 +13671,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -13602,7 +13725,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -13656,7 +13779,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -13710,7 +13833,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -13764,7 +13887,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -13818,7 +13941,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -13872,7 +13995,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -13926,7 +14049,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -13980,7 +14103,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -14034,7 +14157,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -14088,7 +14211,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -14142,7 +14265,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -14196,7 +14319,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -14250,7 +14373,61 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -15044,18 +15221,18 @@

-
+
-
+

- +

-
+
Type: object
-

Discovery of features supported by this device.

+ alarms
Type: object
+

Information about a specific alarm name of the device.

No Additional Properties @@ -15074,23 +15251,23 @@

-
+
-
+

- +

-
+

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

- Property name regular expression: ^[._a-zA-Z]+$ + Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

Feature Discovery

Type: object
-

Object representation for for a single feature

+ Alarm Alarmset Model

Alarm Alarmset Model

Type: object
+

Information about a specific alarm name of the device.

No Additional Properties @@ -15118,18 +15295,18 @@

-
+
-
+

- +

-
+

FeatureStage

Type: enum (of string)
-

Stage of a feature implemenation

+ description
Type: string
+

Detailed description of this alarm

- -
-

Must be one of:

-
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
-
@@ -15171,26 +15343,18 @@

Must be one of:

-
-
-
-

-
-
-
-
-
+
-
+

- +

-
+

Cloud Model

Type: object
-

Information specific to how the device communicates with the cloud.

+ alarms + + + + Alarm Alarmset Model + + + + category
Type: string
+

Category that this alarm is classified as

- - No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Mapping for the alarm to its internal counterpart

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Collection of alarm information

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ +

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Friendly name for the reference, if known

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Collection of alarm references

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ +

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Friendly name for the reference, if known

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Discovery of features supported by this device.

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[._a-zA-Z]+$ +
+ +

Feature Discovery

Type: object
+

Object representation for for a single feature

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+
+ +

FeatureStage

Type: enum (of string)
+

Stage of a feature implemenation

+
+ +
+

Must be one of:

+
  • "disabled"
  • "alpha"
  • "preview"
  • "beta"
  • "stable"
+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +

Cloud Model

Type: object
+

Information specific to how the device communicates with the cloud.

+
+ + No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
diff --git a/gencode/docs/events_mapping.html b/gencode/docs/events_mapping.html index 5583308f57..63adfa2a4b 100644 --- a/gencode/docs/events_mapping.html +++ b/gencode/docs/events_mapping.html @@ -436,6 +436,11 @@

id="status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_status_category_oneOf_i36" role="tab" onclick="setAnchor('#status_category_oneOf_i36')" >Option 37 +
@@ -1070,7 +1075,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1110,7 +1115,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1150,7 +1155,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1190,7 +1195,7 @@

/> item 18

Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1230,7 +1235,7 @@

/> item 19

Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1270,7 +1275,7 @@

/> item 20

Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1310,7 +1315,7 @@

/> item 21

Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1350,7 +1355,7 @@

/> item 22

Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1390,7 +1395,7 @@

/> item 23

Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1430,7 +1435,7 @@

/> item 24

Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1470,7 +1475,7 @@

/> item 25

Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1510,7 +1515,7 @@

/> item 26

Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1550,7 +1555,7 @@

/> item 27

Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1590,7 +1595,7 @@

/> item 28

Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1630,7 +1635,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -1670,7 +1675,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -1710,7 +1715,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -1750,7 +1755,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -1790,7 +1795,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -1830,7 +1835,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -1870,7 +1875,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -1910,7 +1915,47 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -2467,7 +2512,7 @@

- + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1536,7 +1541,7 @@

/> item 20

Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1583,7 +1588,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1630,7 +1635,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1677,7 +1682,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1724,7 +1729,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1771,7 +1776,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1818,7 +1823,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1865,7 +1870,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1912,7 +1917,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1959,7 +1964,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2006,7 +2011,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2053,7 +2058,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2100,7 +2105,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2147,7 +2152,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2194,7 +2199,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2241,7 +2246,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -2288,7 +2293,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/events_udmi.html b/gencode/docs/events_udmi.html index 9051ebca31..6c78b3ecd3 100644 --- a/gencode/docs/events_udmi.html +++ b/gencode/docs/events_udmi.html @@ -483,6 +483,11 @@

id="logentries_items_category_oneOf_i36" data-toggle="tab" href="#tab-pane_logentries_items_category_oneOf_i36" role="tab" onclick="setAnchor('#logentries_items_category_oneOf_i36')" >Option 37 +
@@ -1229,7 +1234,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1276,7 +1281,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1323,7 +1328,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1370,7 +1375,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1417,7 +1422,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1464,7 +1469,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1511,7 +1516,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1558,7 +1563,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1605,7 +1610,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1652,7 +1657,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1699,7 +1704,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1746,7 +1751,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1793,7 +1798,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1840,7 +1845,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1887,7 +1892,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -1934,7 +1939,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -1981,7 +1986,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2028,7 +2033,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2075,7 +2080,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2122,7 +2127,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2169,7 +2174,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -2216,7 +2221,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/events_validation.html b/gencode/docs/events_validation.html index 2af01eb25f..a64c2e7c07 100644 --- a/gencode/docs/events_validation.html +++ b/gencode/docs/events_validation.html @@ -504,6 +504,11 @@

id="status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_status_category_oneOf_i36" role="tab" onclick="setAnchor('#status_category_oneOf_i36')" >Option 37 +
@@ -1138,7 +1143,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1178,7 +1183,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1218,7 +1223,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1258,7 +1263,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1298,7 +1303,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1338,7 +1343,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1378,7 +1383,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1418,7 +1423,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1458,7 +1463,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -1498,7 +1503,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -1538,7 +1543,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -1578,7 +1583,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -1618,7 +1623,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -1658,7 +1663,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -1698,7 +1703,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -1738,7 +1743,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -1778,7 +1783,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -1818,7 +1823,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -1858,7 +1863,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -1898,7 +1903,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -1938,7 +1943,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -1978,7 +1983,47 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -2659,6 +2704,11 @@

id="errors_items_category_oneOf_i36" data-toggle="tab" href="#tab-pane_errors_items_category_oneOf_i36" role="tab" onclick="setAnchor('#errors_items_category_oneOf_i36')" >Option 37 +
@@ -3405,7 +3455,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -3452,7 +3502,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -3499,7 +3549,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -3546,7 +3596,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -3593,7 +3643,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -3640,7 +3690,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -3687,7 +3737,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -3734,7 +3784,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -3781,7 +3831,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -3828,7 +3878,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -3875,7 +3925,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -3922,7 +3972,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -3969,7 +4019,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -4016,7 +4066,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -4063,7 +4113,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -4110,7 +4160,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -4157,7 +4207,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -4204,7 +4254,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -4251,7 +4301,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -4298,7 +4348,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -4345,7 +4395,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -4392,7 +4442,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/metadata.html b/gencode/docs/metadata.html index 68d059d9a9..db822e8e7e 100644 --- a/gencode/docs/metadata.html +++ b/gencode/docs/metadata.html @@ -1005,10 +1005,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -3935,13 +3935,13 @@

Entity relationships to other devices, keyed by target device ID

+ + + + - - - - - +
@@ -3977,12 +3977,12 @@

^[-0-9a-zA-Z]+$

Type: object
+ + + - - - - +
@@ -4025,15 +4025,15 @@

^[-0-9a-zA-Z_]+$

Type: array of object
+ - - - + + No Additional Items

Each item of this array must be:

- + Type: object
+ + + - - - - +
@@ -4122,15 +4122,15 @@

tags

Type: array of string
+ - - - + + No Additional Items

Each item of this array must be:

- + Type: string
+ + + - - - - +

Example:
@@ -4726,10 +4726,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -5875,10 +5875,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -5929,12 +5929,12 @@

networks

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

No Additional Properties + + + - - - - +
@@ -6031,10 +6031,10 @@

addr

Type: string

The address of a device on the fieldbus/local network

+ - - - + +
Examples:
@@ -6092,10 +6092,10 @@

network

Type: string

The network designator for this device in the family-defined format

+ - - - + +
Examples:
@@ -6152,12 +6152,12 @@

adjunct

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

^[a-z_]+$

Type: string
+ + + - - - - +

@@ -6273,12 +6273,12 @@

shadow_id

Type: string

Specifies that this is a shadow of the indicated device

+ + + - - - - +
@@ -6328,12 +6328,12 @@

parent_id

Type: string

The device id of the node's parent

+ + + - - - - +
@@ -6383,10 +6383,10 @@

familyType: string

The family designator, used only when the entry is not keyed in a family map

+ - - - + +
Examples:
@@ -6444,10 +6444,10 @@

network_idType: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
@@ -6915,12 +6915,12 @@

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

alarms

Type: object

Information about a specific alarm name of the device.

No Additional Properties + + + - - - - +
@@ -7003,24 +7003,79 @@

No Additional Properties + + + + +
+
+
+

+ +

+
+
+
+ Type: string
+

Detailed description of this alarm

+
+ + + -
+ +
+
+
+
+
-
+

- +

-
+
Type: string
-

Expected unit configuration for the alarm

+ category
Type: string
+

Category that this alarm is classified as

+ + + + +
+
+
+
+
+
+
+

+ +

+
+
+
+ Type: string
+

Severity of the alarm

+
+ + + +
-
+
-
+

- +

-
+
Type: enum (of string)
-

Expected data type for the alarm

-
-

Must be one of:

-
  • "string"
  • "boolean"
  • "number"
-
- - - - + requires_ack
Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + +
-
+
-
+

- +

-
+
Type: string
-

Detailed description of this alarm

+ return_to_normal_event
Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+ + + - - - - +
-
+
-
+

- +

-
+
Type: boolean
-

Indicates if this alarm is writable (else read-only)

+ return_requires_ack
Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+ + + - - - - +
-
+
-
+

- +

-
+
Type: object
-

Represents the expected baseline value of the alarm

+ ref
Type: string
+

Mapping for the alarm to its internal counterpart

+ + + - - - -
-
Example:
-
22
-
-
+
-
+
-
+

- +

-
+
Type: number
-

Maximum deviation from baseline_value

-
- - - + structure
Type: object
+

Collection of alarm information

+
No Additional Properties + + + -
-
Example:
-
2
-
-
-
-
-
-
-
+ +
-
+

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
Type: enum (of string)
-

Expected state when baseline_value is set as the set_value for this alarm the config message

-
-

Must be one of:

-
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- - - + structure + + + + Alarm Ref Discovery

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ No Additional Properties + + + -
-
-
-
-
+ +
-
+

- +

-
+
Type: number
-

Represents the lower bound of the error threshold for a alarm

-
- - - + structure + + + + Alarm Ref Discovery + + + + alarm
Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + -
-
Example:
-
0
-
-
+
-
+
-
+

- +

-
+
Type: number
-

Represents the upper bound of the error threshold for a alarm

+ structure + + + + Alarm Ref Discovery + + + + name
Type: string
+

Friendly name for the reference, if known

+ + + - - - -
-
Example:
-
100
-
-
+
-
+
-
+

- +

-
+
Type: integer
-

Represents the limit in seconds that a alarm can be unchanged for

+ structure + + + + Alarm Ref Discovery + + + + description
Type: string
+

Detailed description of this alarm

+ + + - - - -
-
Example:
-
3600
-
-
+
-
+
-
+

- +

-
+
Type: number
-

Triggering threshold for partial cov update publishing

+ structure + + + + Alarm Ref Discovery + + + + category
Type: string
+

Category that this alarm is classified as

+ + + - - - -
-
Example:
-
1
-
-
+
-
+
-
+

- +

-
+
Type: string
-

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

+ structure + + + + Alarm Ref Discovery + + + + severity
Type: string
+

Severity of the alarm

+ + + - - - -
-
Examples:
-
"AI3"
-
-
"400070"
-
-
+
-
+
-
+

- +

-
+
Type: object
- No Additional Properties - - - - + structure + + + + Alarm Ref Discovery + + + + requires_ack
Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + -
+ +
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+
Type: string
- - - - - + Alarm Ref Discovery + + + + return_to_normal_event
Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + +
-
-
-
-
-
+
-
+

- +

-
+
Type: array
-

Tags assosciated with the alarm

-
- - - - - -

All items must be unique

No Additional Items

Each item of this array must be:

-
-
- - - Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^[a-z0-9]+$ - - - + exclude_alarms_from_config
Type: boolean
+ + + + +
-

-
Examples:
-
[
-    "lighting"
-]
-
-
[
-    "energy",
-    "hvac"
-]
-
+
-
+
-
+

- +

-
+

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 + + + + + + +
+
+
+

+ +

+
+ +
+
+ + Type: object
-

Collection of family alarm information

+ points
Type: object
+

Information about a specific point name of the device.

No Additional Properties + + + - - - - -
+ +
-
+

- +

-
+

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

- Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ + Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

Ref Discovery

Type: object
-

Object representation for for a single point reference discovery

+ Point Pointset Model

Point Pointset Model

Type: object
+

Information about a specific point name of the device.

No Additional Properties + + + - - - - -
+ +
-
+

- +

-
+
Type: string
-

Point descriptor for this point

-
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - - - - + units
Type: string
+

Expected unit configuration for the point

+
+ + + +
-
+
-
+

- +

-
+
Type: string
-

Friendly name for the reference, if known

-
- - - - + type
Type: enum (of string)
+

Expected data type for the point

+
+

Must be one of:

+
  • "string"
  • "boolean"
  • "number"
+
+ + + +
-
+
-
+

- +

-
+
Type: array of string
-

List of possible enumerated values for the point

+ description
Type: string
+

Detailed description of this point

+ + + - - - - No Additional Items

Each item of this array must be:

+ +
+
+
+
+
-
+
+

+ +

+
+
+
Type: string
- - - - - + writable
Type: boolean
+

Indicates if this point is writable (else read-only)

+
+ + + -
-
+
-
+
-
+

- +

-
+
Type: string
-

Current or default unit for this point

+ baseline_value
Type: object
+

Represents the expected baseline value of the point

+ + + - - - - +
+
Example:
+
22
+
+
-
+
-
+

- +

-
+
Type: string
-

Family reference for structures

+ baseline_tolerance
Type: number
+

Maximum deviation from baseline_value

+ + + - - - - +
+
Example:
+
2
+
+
-
+
-
+

- +

-
+
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"
+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Current or default type for this point

+ points + + + + Point Pointset Model + + + + range_min
Type: number
+

Represents the lower bound of the error threshold for a point

+ + + - - - - +
+
Example:
+
0
+
+
-
+
-
+

- +

-
+
Type: number
+

Represents the upper bound of the error threshold for a point

+
+ + + + + +
+
Example:
+
100
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: boolean
-

Indicates if this point is writable or not

+ points + + + + Point Pointset Model + + + + unchanged_limit_sec
Type: integer
+

Represents the limit in seconds that a point can be unchanged for

+ + + - - - - +
+
Example:
+
3600
+
+
-
+
-
+

- +

-
+
Type: number
+

Triggering threshold for partial cov update publishing

+
+ + + + + +
+
Example:
+
1
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Human-readable description of this point

+ points + + + + Point Pointset Model + + + + ref
Type: string
+

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

+ + + - - - - +
+
Examples:
+
"AI3"
+
+
"400070"
+
+
-
+
-
+

- +

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

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
+ +

Entry

Type: object
- - - No Additional Properties - - - + points + + + + Point Pointset Model + + + + adjunct + + + + ^[a-z_]+$
Type: string
+ + + -
+ +
+
+
+
+
+
+
+
+
-
+

- +

-
+
Type: array
+

Tags assosciated with the point

+
+ + + + + +

All items must be unique

No Additional Items

Each item of this array must be:

+
+
+ + + Type: string
-

A human-readable one-line description of the entry

-
- - - + Point Pointset Model + + + + tags + + + + tags items
Type: object
+Must match regular expression: ^[a-z0-9]+$ + + + -
-
Example:
-
"Point is not writable"
+        
+        
+

+
Examples:
+
[
+    "lighting"
+]
+
+
[
+    "energy",
+    "hvac"
+]
 
-
+
-
+

- +

-
+
Type: object
+

Collection of family point information

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ + Type: string
-

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

+ structure + + + + Ref Discovery

Ref Discovery

Type: object
+

Object representation for for a single point reference discovery

+ No Additional Properties + + + - - - -
-
-
-
-
+ +
-
+

- +

-
+
Type: string
+

Point descriptor for this point

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +

Category

Type: string
- - -

- -

-
- - - Type: string
+

Friendly name for the reference, if known

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^system\.base\.start$ - - - - - - -
- - - Type: array of string
+

List of possible enumerated values for the point

+
+ + + + + + No Additional Items

Each item of this array must be:

+
+
+ + + Type: object
-Must match regular expression: ^system\.base\.shutdown$ - - - + possible_values items
Type: string
+ + + -
+ +
+
+
+
+
+
+
+
+
+

+ +

+
+
+
Type: string
+

Current or default unit for this point

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^system\.base\.ready$ - - - - - - -
- - - Type: string
+

Family reference for structures

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^system\.config\.receive$ - - - - + type
Type: string
+

Current or default type for this point

+
+ + + -
+ +
+
+
+
+
+
+
+

+ +

+
+
+
Type: boolean
+

Indicates if this point is writable or not

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^system\.config\.parse$ - - - - - - -
- - - Type: string
+

Human-readable description of this point

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^system\.config\.apply$ - - + status

Entry

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

+ +

+
+
+
Type: object
-Must match regular expression: ^system\.auth\.login$ - - - - + message
Type: string
+

A human-readable one-line description of the entry

+
+ + + -
+
+
Example:
+
"Point is not writable"
+
+
+
+
+
+
+
+
+
+

+ +

+
+
+
Type: object
-Must match regular expression: ^system\.auth\.logout$ - - - - + detail
Type: string
+

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

+
+ + + -
+ +
+
+
+
+
+
+
+

+ +

+
+
+
Type: object
-Must match regular expression: ^system\.auth\.fail$ - - - - - + category

Category

Type: string
-
+

+ +

+
+ Type: object
-Must match regular expression: ^pointset\.point\.nominal$ - - - - + item 0
Type: object
+Must match regular expression: ^system\.base\.start$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i1" role="tabpanel"> + Type: object
-Must match regular expression: ^pointset\.point\.applied$ - - - - + item 1
Type: object
+Must match regular expression: ^system\.base\.shutdown$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i2" role="tabpanel"> + Type: object
-Must match regular expression: ^pointset\.point\.updating$ - - - - + item 2
Type: object
+Must match regular expression: ^system\.base\.ready$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i3" role="tabpanel"> + Type: object
-Must match regular expression: ^pointset\.point\.overridden$ - - - - + item 3
Type: object
+Must match regular expression: ^system\.config\.receive$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i4" role="tabpanel"> + Type: object
-Must match regular expression: ^pointset\.point\.failure$ - - - - + item 4
Type: object
+Must match regular expression: ^system\.config\.parse$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i5" role="tabpanel"> + Type: object
-Must match regular expression: ^pointset\.point\.invalid$ - - - - + item 5
Type: object
+Must match regular expression: ^system\.config\.apply$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i6" role="tabpanel"> + Type: object
-Must match regular expression: ^localnet\.network$ - - - - + item 6
Type: object
+Must match regular expression: ^system\.auth\.login$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i7" role="tabpanel"> + Type: object
-Must match regular expression: ^localnet\.network\.connect$ - - - - + item 7
Type: object
+Must match regular expression: ^system\.auth\.logout$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i8" role="tabpanel"> + Type: object
-Must match regular expression: ^gateway\.setup\.attach$ - - - - + item 8
Type: object
+Must match regular expression: ^system\.auth\.fail$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i9" role="tabpanel"> + Type: object
-Must match regular expression: ^gateway\.proxy\.target$ - - - - + item 9
Type: object
+Must match regular expression: ^pointset\.point\.nominal$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i10" role="tabpanel"> + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ - - - - + item 10
Type: object
+Must match regular expression: ^pointset\.point\.applied$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i11" role="tabpanel"> + Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - + item 11
Type: object
+Must match regular expression: ^pointset\.point\.updating$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i12" role="tabpanel"> + Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ - - - - + item 12
Type: object
+Must match regular expression: ^pointset\.point\.overridden$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i13" role="tabpanel"> + Type: object
-Must match regular expression: ^discovery\.point\.describe$ - - - - + item 13
Type: object
+Must match regular expression: ^pointset\.point\.failure$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i14" role="tabpanel"> + Type: object
-Must match regular expression: ^mapping\.device\.apply$ - - - - + item 14
Type: object
+Must match regular expression: ^pointset\.point\.invalid$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i15" role="tabpanel"> + Type: object
-Must match regular expression: ^blobset\.blob\.receive$ - - - - + item 15
Type: object
+Must match regular expression: ^alarmset\.alarm\.invalid$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i16" role="tabpanel"> + Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ - - - - + item 16
Type: object
+Must match regular expression: ^localnet\.network$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i17" role="tabpanel"> + Type: object
-Must match regular expression: ^blobset\.blob\.apply$ - - - - + item 17
Type: object
+Must match regular expression: ^localnet\.network\.connect$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i18" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.receive$ - - - - + item 18
Type: object
+Must match regular expression: ^gateway\.setup\.attach$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i19" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.schema$ - - - - + item 19
Type: object
+Must match regular expression: ^gateway\.proxy\.target$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i20" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.content$ - - - - + item 20
Type: object
+Must match regular expression: ^gateway\.proxy\.connect$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i21" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - + item 21
Type: object
+Must match regular expression: ^discovery\.family\.scan$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i22" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.extra$ - - - - + item 22
Type: object
+Must match regular expression: ^discovery\.device\.enumerate$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i23" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - + item 23
Type: object
+Must match regular expression: ^discovery\.point\.describe$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i24" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ - - - - + item 24
Type: object
+Must match regular expression: ^mapping\.device\.apply$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i25" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.schema$ - - - - + item 25
Type: object
+Must match regular expression: ^blobset\.blob\.receive$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i26" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - - + item 26
Type: object
+Must match regular expression: ^blobset\.blob\.fetch$ + + + +
- + id="tab-pane_pointset_points_pattern1_structure_pattern1_status_category_oneOf_i27" role="tabpanel"> + Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - - - - - - -
- - - - - + item 27
Type: object
+Must match regular expression: ^blobset\.blob\.apply$ + -
-
-
-
-
-
-
-

- -

-
+ + -
-
+ +
+ Type: stringFormat: date-time
-

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

-
- - - - + oneOf + + + + item 28
Type: object
+Must match regular expression: ^validation\.device\.receive$ + -
-
Example:
-
"2018-08-26T21:39:28.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
+ + -
-
+ +
+ 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

- -
-
Example:
-
600
-
-
-
-
-
-
-
-
-
-
-
-
-
-

- -

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

Ancillary Properties

Type: object
-

Arbitrary blob of json associated with this point

-
- - - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
+Must match regular expression: ^validation\.device\.content$ + + + + + + +
+ + + Type: object
- No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
- - Type: string
- - - - - - + oneOf + + + + item 31
Type: object
+Must match regular expression: ^validation\.device\.multiple$ + -
-
-
-
-
-
-
-
-
-
-
-

- -

-
+ + -
-
+ +
+ Type: object
- - - - - - - -
-
-
-

- -

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

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-
- - Type: object
+Must match regular expression: ^validation\.summary\.report$ + + + + + + +
+ + + Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
+Must match regular expression: ^validation\.feature\.sequence$ + + + + + + +
+ + + Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - - -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
-

Reference links to alternate families

-
No Additional Properties - - - - - + item 35
Type: object
+Must match regular expression: ^validation\.feature\.schema$ + -
-
-
-

- -

-
+ + -
-

- -

-

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]+)*$ -
+ +
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties - - - - - + oneOf + + + + item 36
Type: object
+Must match regular expression: ^validation\.feature\.capability$ + -
-
-
-

- -

-
+ + -
-
+ +
+ Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - + item 37
Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ + + + + +
+ + + +
-
+
-
+

- +

-
+
Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - + timestamp
Type: stringFormat: date-time
+

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

+
+ + + -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
Example:
+
"2018-08-26T21:39:28.364Z"
+
-
+
-
+

- +

-
+
Type: boolean
- - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: boolean
- - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: 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

- - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: 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.

+ 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 1 and lesser or equal to 86400

- - +
+
Example:
+
600
+
+
@@ -13156,18 +13410,18 @@

-
+
-
+

- +

-
+

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 - - - - - - -
-
-
-

- -

-
- -
-
- - Type: object
-

Information about a specific point name of the device.

-
No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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]+)*$ -
- -

Point Pointset Model

Type: object
-

Information about a specific point name of the device.

+ ancillary

Ancillary Properties

Type: object
+

Arbitrary blob of json associated with this point

- No Additional Properties + -
+
+
+
+
+
-
+

- +

-
+
Type: string
-

Expected unit configuration for the point

-
+ structure + + + + Ref Discovery + + + + adjunct
Type: object
+ No Additional Properties -
-
-
-
-
+
-
+

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
Type: enum (of string)
-

Expected data type for the point

-
-

Must be one of:

-
  • "string"
  • "boolean"
  • "number"
-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: string
-

Detailed description of this point

-
+ ^[a-z_]+$
Type: string
+ @@ -13444,18 +13625,22 @@

-
+
+
+
+
+
-
+

- +

-
+
Type: boolean
-

Indicates if this point is writable (else read-only)

-
+ structure + + + + Ref Discovery + + + + structure
Type: object
+ -
-
-
-
-
+
-
+

- +

-
+
Type: object
-

Represents the expected baseline value of the point

-
- - - - - -
-
Example:
-
22
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: number
-

Maximum deviation from baseline_value

+ point

Family Discovery

Type: object
+

Discovery information for a protocol family.

+ + No Additional Properties -
-
Example:
-
2
-
-
-
-
-
-
-
+ +
-
+

- +

-
+
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"
-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: number
-

Represents the lower bound of the error threshold for a point

-
+ addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
-
Example:
-
0
-
-
+
-
+
-
+

- +

-
+
Type: number
-

Represents the upper bound of the error threshold for a point

-
- - - - - -
-
Example:
-
100
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: integer
-

Represents the limit in seconds that a point can be unchanged for

-
+ ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
-
Example:
-
3600
-
+ +
+
+
-
+
-
+

- +

-
+
Type: number
-

Triggering threshold for partial cov update publishing

-
- - - - - -
-
Example:
-
1
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: string
-

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

-
+ families
Type: object
+

Reference links to alternate families

+
No Additional Properties -
-
Examples:
-
"AI3"
-
-
"400070"
-
-
-
-
-
-
-
+ +
-
+

- +

-
-
+
+

+ +

+

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]+)*$ +
Type: object
- No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
- - Type: string
+ Family Discovery

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ No Additional Properties -
-
-
-
-
-
-
-
-
+
-
+

- +

-
+
Type: array
-

Tags assosciated with the point

-
- - - - - -

All items must be unique

No Additional Items

Each item of this array must be:

-
-
- - - Type: object
-Must match regular expression: ^[a-z0-9]+$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
-

-
Examples:
-
[
-    "lighting"
-]
-
-
[
-    "energy",
-    "hvac"
-]
-
-
-
+
-
+

- +

-
+
Type: object
-

Collection of family point information

-
No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ -
- -

Ref Discovery

Type: object
-

Object representation for for a single point reference discovery

-
- - No Additional Properties + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Point descriptor for this point

-
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + exclude_units_from_config
Type: boolean
+ @@ -14392,18 +14402,18 @@

-
+
-
+

- +

-
+
Type: boolean
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Friendly name for the reference, if known

+ sample_limit_sec
Type: 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

-
+
-
+

- +

-
+
Type: 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

+ + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+ + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
+ + Type: array of string
-

List of possible enumerated values for the point

+ Discovery Events

Discovery Events

Type: object
+

Discovery result with implicit discovery

+ + No Additional Properties - No Additional Items

Each item of this array must be:

+ +
-
- +
+

+ +

+
+ +
+
Type: string
- - - - - - - -
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: string
-

Current or default unit for this point

+ timestamp
Type: stringFormat: date-time
+

RFC 3339 UTC timestamp the discover telemetry event was generated

- -
-
-
+
+
Example:
+
"2019-01-17T14:02:29.364Z"
+
-
-
-
-

- -

-
- -
-
- - Type: string
-

Family reference for structures

-
- - - - - -
-
+
-
+

- +

-
+
Type: string
-

Current or default type for this point

+ version
Type: string
+

Version of the UDMI schema

@@ -14800,18 +14701,18 @@

-
+
-
+

- +

-
+
Type: boolean
-

Indicates if this point is writable or not

+ generation
Type: stringFormat: date-time
+

The event's discovery scan trigger's generation timestamp

- -
-
-
+
+
Example:
+
"2019-01-17T14:02:29.364Z"
+
-
-
-
-

- -

-
- -
-
- - Type: string
-

Human-readable description of this point

-
- - - - - -
-
+
-
+

- +

-
+

Entry

Type: object
+ status

Entry

Type: object
No Additional Properties @@ -15004,18 +14798,18 @@

-
+
-
+

- +

-
+
Type: string
+ message
Type: string

A human-readable one-line description of the entry

@@ -15077,3221 +14850,25 @@


Example:
-
"Point is not writable"
+
"Point is not writable"
 

-
-
-
-

- -

-
- -
-
- - Type: string
-

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

-
- - - - - - -
-
-
-
-
+
-
+

- +

-
-
- -

Category

Type: string
- - -

- -

-
- - - Type: object
-Must match regular expression: ^system\.base\.start$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.base\.shutdown$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.base\.ready$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.config\.receive$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.config\.parse$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.config\.apply$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.auth\.login$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.auth\.logout$ - - - - - - -
- - - Type: object
-Must match regular expression: ^system\.auth\.fail$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.nominal$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.applied$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.updating$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.overridden$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.failure$ - - - - - - -
- - - Type: object
-Must match regular expression: ^pointset\.point\.invalid$ - - - - - - -
- - - Type: object
-Must match regular expression: ^localnet\.network$ - - - - - - -
- - - Type: object
-Must match regular expression: ^localnet\.network\.connect$ - - - - - - -
- - - Type: object
-Must match regular expression: ^gateway\.setup\.attach$ - - - - - - -
- - - Type: object
-Must match regular expression: ^gateway\.proxy\.target$ - - - - - - -
- - - Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ - - - - - - -
- - - Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - - - -
- - - Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ - - - - - - -
- - - Type: object
-Must match regular expression: ^discovery\.point\.describe$ - - - - - - -
- - - Type: object
-Must match regular expression: ^mapping\.device\.apply$ - - - - - - -
- - - Type: object
-Must match regular expression: ^blobset\.blob\.receive$ - - - - - - -
- - - Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ - - - - - - -
- - - Type: object
-Must match regular expression: ^blobset\.blob\.apply$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.device\.receive$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.device\.schema$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.device\.content$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.device\.extra$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.feature\.sequence$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.feature\.schema$ - - - - - - -
- - - Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - - - - -
- - - Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - - - - - - -
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: stringFormat: date-time
-

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

-
- - - - - -
-
Example:
-
"2018-08-26T21:39:28.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
+
Type: string
+

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

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + 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

+ status + + + + category

Category

Type: string
-
-
Example:
-
600
-
-
-
-
-
-
-
-
-
-
-
-
-
-

- -

-
-
-
+

+ +

+
+

Ancillary Properties

Type: object
-

Arbitrary blob of json associated with this point

-
- - + item 0
Type: object
+Must match regular expression: ^system\.base\.start$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: object
- No Additional Properties + item 1
Type: object
+Must match regular expression: ^system\.base\.shutdown$ -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+ Type: string
- + item 2
Type: object
+Must match regular expression: ^system\.base\.ready$ -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: object
- + item 3
Type: object
+Must match regular expression: ^system\.config\.receive$ -
-
-
-

- -

-
- -
-
+
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties + item 4
Type: object
+Must match regular expression: ^system\.config\.parse$ -
-
-
-

- -

-
- -
-
+
+ Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + item 5
Type: object
+Must match regular expression: ^system\.config\.apply$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: object
+Must match regular expression: ^system\.auth\.login$ + + + + + + +
+ + + Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - - -
-
-
-
-
-
-
-
-
-
-
-

- -

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

Reference links to alternate families

-
No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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]+)*$ -
- - Type: object
+Must match regular expression: ^system\.auth\.fail$ + + + + + + +
+ + +

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties + item 9
Type: object
+Must match regular expression: ^pointset\.point\.nominal$ -
-
-
-

- -

-
- -
-
+
+ Type: object
+Must match regular expression: ^pointset\.point\.applied$ + + + + + + +
+ + + Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
+Must match regular expression: ^pointset\.point\.updating$ + + + + + + +
+ + + Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + item 12
Type: object
+Must match regular expression: ^pointset\.point\.overridden$ -
-
-
-
-
-
-
-
-
-
-
-
-
-

-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: boolean
- - - - - - + item 13
Type: object
+Must match regular expression: ^pointset\.point\.failure$ + -
-
-
-
-
-
-
-

- -

-
+ + -
-
+ +
+ Type: boolean
- - - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: 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

- - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: 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.

-
+ item 14
Type: object
+Must match regular expression: ^pointset\.point\.invalid$ -

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

- -
-
-
-
-
-
-
-
-
-
-
-

- -

-
-
-
+ +
+ Type: object
- - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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]+)*$ -
- -

Discovery Events

Type: object
-

Discovery result with implicit discovery

-
- - No Additional Properties + oneOf + + + + item 15
Type: object
+Must match regular expression: ^alarmset\.alarm\.invalid$ -
-
-
-

- -

-
- -
-
+
+ Type: stringFormat: date-time
-

RFC 3339 UTC timestamp the discover telemetry event was generated

-
- - - - - -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: string
-

Version of the UDMI schema

-
+ item 16
Type: object
+Must match regular expression: ^localnet\.network$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: stringFormat: date-time
-

The event's discovery scan trigger's generation timestamp

-
+ status + + + + category + + + + oneOf + + + + item 17
Type: object
+Must match regular expression: ^localnet\.network\.connect$ -
-
Example:
-
"2019-01-17T14:02:29.364Z"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+ +
+

Entry

Type: object
- - - No Additional Properties + status + + + + category + + + + oneOf + + + + item 18
Type: object
+Must match regular expression: ^gateway\.setup\.attach$ -
-
-
-

- -

-
- -
-
+
+ Type: string
-

A human-readable one-line description of the entry

-
+ category + + + + oneOf + + + + item 19
Type: object
+Must match regular expression: ^gateway\.proxy\.target$ -
-
Example:
-
"Point is not writable"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+ +
+ Type: string
-

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

-
+ category + + + + oneOf + + + + item 20
Type: object
+Must match regular expression: ^gateway\.proxy\.connect$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+

Category

Type: string
+ category + + + + oneOf + + + + item 21
Type: object
+Must match regular expression: ^discovery\.family\.scan$ + + + -

- -

-
+ +
Type: object
-Must match regular expression: ^system\.base\.start$ + item 22
Type: object
+Must match regular expression: ^discovery\.device\.enumerate$ @@ -20154,7 +16393,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i23" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.shutdown$ + item 23
Type: object
+Must match regular expression: ^discovery\.point\.describe$ @@ -20208,7 +16447,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i24" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.ready$ + item 24
Type: object
+Must match regular expression: ^mapping\.device\.apply$ @@ -20262,7 +16501,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i25" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.receive$ + item 25
Type: object
+Must match regular expression: ^blobset\.blob\.receive$ @@ -20316,7 +16555,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i26" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.parse$ + item 26
Type: object
+Must match regular expression: ^blobset\.blob\.fetch$ @@ -20370,7 +16609,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i27" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.apply$ + item 27
Type: object
+Must match regular expression: ^blobset\.blob\.apply$ @@ -20424,7 +16663,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i28" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.login$ + item 28
Type: object
+Must match regular expression: ^validation\.device\.receive$ @@ -20478,7 +16717,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i29" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.logout$ + item 29
Type: object
+Must match regular expression: ^validation\.device\.schema$ @@ -20532,7 +16771,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i30" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.fail$ + item 30
Type: object
+Must match regular expression: ^validation\.device\.content$ @@ -20586,7 +16825,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i31" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.nominal$ + item 31
Type: object
+Must match regular expression: ^validation\.device\.multiple$ @@ -20640,7 +16879,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i32" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.applied$ + item 32
Type: object
+Must match regular expression: ^validation\.device\.extra$ @@ -20694,7 +16933,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i33" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.updating$ + item 33
Type: object
+Must match regular expression: ^validation\.summary\.report$ @@ -20748,7 +16987,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i34" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.overridden$ + item 34
Type: object
+Must match regular expression: ^validation\.feature\.sequence$ @@ -20802,7 +17041,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i35" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.failure$ + item 35
Type: object
+Must match regular expression: ^validation\.feature\.schema$ @@ -20856,7 +17095,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i36" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.invalid$ + item 36
Type: object
+Must match regular expression: ^validation\.feature\.capability$ @@ -20910,7 +17149,7 @@

+ id="tab-pane_structure_pattern1_status_category_oneOf_i37" role="tabpanel"> Type: object
-Must match regular expression: ^localnet\.network$ + item 37
Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ -
- +
+ + + + + + + + + + +
+
+
+

+ +

+
+ +
+
Type: stringFormat: date-time
+

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

+
+ + + + + +
+
Example:
+
"2018-08-26T21:39:28.364Z"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^localnet\.network\.connect$ + Discovery Events + + + + status + + + + 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

- -
- +
+
Example:
+
600
+
+
+
+
+
+ + + + + +
+
+
+

+ +

+
+ +
+
Type: object
+ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^gateway\.setup\.attach$ + addr
Type: string
+

The primary address of the device (for indicated family)

+
-
- +
+
+
+ +
+
+
+

+ +

+
+ +
+
Type: string
+

The family network designator of the discovered device

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^gateway\.proxy\.target$ + event_no
Type: integer
+

The active or passive series number of this result (matches reported state values)

+
-
- +
+
+
+ +
+
+
+

+ +

+
+ +
+
Type: object
+

Links to other address families (family and id)

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
+ + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ + families + + + + Family Discovery

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^discovery\.family\.scan$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+
+
+ + + +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^discovery\.point\.describe$ + registries
Type: object
+

Registry iot cloud models

+
No Additional Properties -
- +
+
+
+

+ +

+
+ +
+

+ +

+

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]*$ +
Type: object
-Must match regular expression: ^mapping\.device\.apply$ + Cloud Model

Cloud Model

Type: object
+

Information specific to how the device communicates with the cloud.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.receive$ + functions_ver
Type: integer
+

Function version of this request

+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ + auth_type
Type: enum (of string)
+

The key type used for cloud communication.

+
+

Must be one of:

+
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.apply$ + device_key
Type: boolean
+

Indicates if the device private key is provided in the site model.

+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.receive$ + resource_type
Type: enum (of string)
+

The cloud resource type

+
+

Must be one of:

+
  • "DIRECT"
  • "GATEWAY"
  • "FUNNEL"
  • "PROXIED"
  • "REGISTRY"
+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.schema$ + gateway

Gateway Model

Type: object
+

Gateway Documentation

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.content$ + 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"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.multiple$ + target

Family Localnet Model

Type: object
+

The type of network

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.extra$ + target + + + + addr
Type: string
+

The address of a device on the fieldbus/local network

+
- -
- +
+
Examples:
+
"192.168.1.3"
+
+
"41489"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.summary\.report$ + target + + + + network
Type: string
+

The network designator for this device in the family-defined format

+
- -
- +
+
Examples:
+
"192.168.1.0/24"
+
+
"12732"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.feature\.sequence$ + target + + + + adjunct
Type: object
+ No Additional Properties -
- +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
Type: object
-Must match regular expression: ^validation\.feature\.schema$ + target + + + + adjunct + + + + ^[a-z_]+$
Type: string
+ -
- +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.feature\.capability$ + shadow_id
Type: string
+

Specifies that this is a shadow of the indicated device

+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - - - - - - -
+ target + + + + parent_id
Type: string
+

The device id of the node's parent

+
@@ -22108,18 +18794,18 @@

-
+
-
+

- +

-
+
Type: stringFormat: date-time
-

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

+ Cloud Model + + + + gateway + + + + target + + + + family
Type: string
+

The family designator, used only when the entry is not keyed in a family map

@@ -22159,26 +18866,28 @@


-
Example:
-
"2018-08-26T21:39:28.364Z"
+
Examples:
+
"ipv4"
+
+
"bacnet"
 

-
+
-
+

- +

-
+
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

- -
-
Example:
-
600
-
-
-
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
- + network_id
Type: string
+

The network within the gateway device to use for this network

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - +
+
Examples:
+
"modbus_1"
+
+
"bacnet_1"
+
+
-
+
+
+
+ +
-
+

- +

-
+
Type: string
-

The primary address of the device (for indicated family)

-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: string
-

The family network designator of the discovered device

+ proxy_ids
Type: array of string
+

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

- -
-
-
-
-
+ No Additional Items

Each item of this array must be:

-
-

- -

-
- -
-
+
+ Type: integer
-

The active or passive series number of this result (matches reported state values)

-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
-

Links to other address families (family and id)

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

+
Example:
+
[
+    "AHU-22"
+]
+
+
+
+
+
+
+ + + + +
-
+

- +

-
-

- -

-

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]+)*$ -
+
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

+ Cloud Model + + + + config

Config Cloud Model

Type: object
+

Information specific to how the device communicates with the cloud.

No Additional Properties @@ -22523,18 +19164,18 @@

-
+
-
+

- +

-
+
Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + config + + + + static_file
Type: string
+

Config file to use. Within the config directory in the device's metadata directory

+
@@ -22585,18 +19233,22 @@

-
+
+
+
+
+
-
+

- +

-
+
Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + blocked
Type: boolean
+ @@ -22647,26 +19298,18 @@

-
-
-

-
-
-
-
-
-
+
-
+

- +

-
+
Type: object
-

Registry iot cloud models

-
No Additional Properties + registries + + + + Cloud Model + + + + detail
Type: string
+ -
+
+
+
+
+
-
+

- +

-
-

- -

-

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]*$ -
+
+

Cloud Model

Type: object
-

Information specific to how the device communicates with the cloud.

-
+ Cloud Model + + + + updated_time
Type: stringFormat: date-time
- No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
Type: integer
-

Function version of this request

-
+ last_state_time
Type: stringFormat: date-time
+ @@ -22819,18 +19481,18 @@

-
+
-
+

- +

-
+
Type: enum (of string)
-

The key type used for cloud communication.

-
-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
+ last_config_time
Type: stringFormat: date-time
+ @@ -22884,18 +19542,18 @@

Must be one of:

-
+
-
+

- +

-
+
Type: boolean
-

Indicates if the device private key is provided in the site model.

-
+ last_error_time
Type: stringFormat: date-time
+ @@ -22946,18 +19603,18 @@

-
+
-
+

- +

-
+
Type: enum (of string)
-

The cloud resource type

-
-

Must be one of:

-
  • "DIRECT"
  • "GATEWAY"
  • "FUNNEL"
  • "PROXIED"
  • "REGISTRY"
-
+ num_id
Type: string
+ @@ -23011,18 +19664,18 @@

Must be one of:

-
+
-
+

- +

-
+

Gateway Model

Type: object
-

Gateway Documentation

-
+ operation

Model Operation

Type: enum (of string)
- No Additional Properties + +
+

Must be one of:

+
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
+
-
+
+
+
+
+
-
+

- +

-
+
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]*$ + metadata_str
Type: string
+

Strigified version of the metadata object, used for internal backend processing

+
-
-
Example:
-
"GAT-100"
-
-
+
-
+
-
+

- +

-
+

Family Localnet Model

Type: object
-

The type of network

+ device_ids
Type: object
+

If operating on the entire registry, then this contains results for multiple devices (batched operation).

- - No Additional Properties -
+
-
+

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[-._a-zA-Z0-9]+$ +
Type: string
-

The address of a device on the fieldbus/local network

-
+ ^[-._a-zA-Z0-9]+$
Type: object
+ -
-
Examples:
-
"192.168.1.3"
-
-
"41489"
-
+ +
+
+
-
+
+
+
+
+
+
+
+
+
-
+

- +

-
+
Type: object
+

Device iot cloud models

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]*$ +
+ + Type: string
-

The network designator for this device in the family-defined format

+ Cloud Model

Cloud Model

Type: object
+

Information specific to how the device communicates with the cloud.

+ + No Additional Properties -
-
Examples:
-
"192.168.1.0/24"
-
-
"12732"
-
-
-
-
-
-
-
+ +
-
+

- +

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

Function version of this request

+
-
+
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+
Type: string
- + auth_type
Type: enum (of string)
+

The key type used for cloud communication.

+
+

Must be one of:

+
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
+
@@ -23533,22 +20164,18 @@

-
-
-
-
-
+
-
+

- +

-
+
Type: string
-

Specifies that this is a shadow of the indicated device

+ device_key
Type: boolean
+

Indicates if the device private key is provided in the site model.

@@ -23613,18 +20226,18 @@

-
+
-
+

- +

-
+
Type: string
-

The device id of the node's parent

-
+ resource_type
Type: enum (of string)
+

The cloud resource type

+
+

Must be one of:

+
  • "DIRECT"
  • "GATEWAY"
  • "FUNNEL"
  • "PROXIED"
  • "REGISTRY"
+
@@ -23689,18 +20291,18 @@

-
+
-
+

- +

-
+
Type: string
-

The family designator, used only when the entry is not keyed in a family map

+ gateway

Gateway Model

Type: object
+

Gateway Documentation

+ + No Additional Properties -
-
Examples:
-
"ipv4"
-
-
"bacnet"
-
-
-
-
-
-
-
+ +
-
+

- +

-
+
- 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]*$ + + +
-
Examples:
-
"modbus_1"
-
-
"bacnet_1"
+
Example:
+
"GAT-100"
 
-
-
-
-
-
+
-
+

- +

-
+
Type: array of string
-

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

+ target

Family Localnet Model

Type: object
+

The type of network

+ + No Additional Properties - No Additional Items

Each item of this array must be:

+ +
-
- +
+

+ +

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

The address of a device on the fieldbus/local network

+
- -
-

-
Example:
-
[
-    "AHU-22"
-]
+        
+
Examples:
+
"192.168.1.3"
+
+
"41489"
 
-
-
-
-
-
+
-
+

- +

-
+

Config Cloud Model

Type: object
-

Information specific to how the device communicates with the cloud.

+ gateway + + + + target + + + + network
Type: string
+

The network designator for this device in the family-defined format

- - No Additional Properties - -
+
+
Examples:
+
"192.168.1.0/24"
+
+
"12732"
+
+
+
+
+
+
+
-
+

- +

-
+
Type: string
-

Config file to use. Within the config directory in the device's metadata directory

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

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
Type: boolean
+ gateway + + + + target + + + + adjunct + + + + ^[a-z_]+$
Type: string
@@ -24193,18 +20813,22 @@

-
+
+
+
+
+
-
+

- +

-
+
Type: string
- + gateway + + + + target + + + + shadow_id
Type: string
+

Specifies that this is a shadow of the indicated device

+
@@ -24254,18 +20893,18 @@

-
+
-
+

- +

-
+
Type: stringFormat: date-time
- + gateway + + + + target + + + + parent_id
Type: string
+

The device id of the node's parent

+
@@ -24315,18 +20969,18 @@

-
+
-
+

- +

-
+
Type: stringFormat: date-time
- + gateway + + + + target + + + + family
Type: string
+

The family designator, used only when the entry is not keyed in a family map

+
- +
+
Examples:
+
"ipv4"
+
+
"bacnet"
+
+
-
+
-
+

- +

-
+
Type: stringFormat: date-time
- + gateway + + + + target + + + + network_id
Type: string
+

The network within the gateway device to use for this network

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - +
+
Examples:
+
"modbus_1"
+
+
"bacnet_1"
+
+
-
+
+
+
+
+
-
+

- +

-
+
Type: stringFormat: date-time
- + gateway + + + + proxy_ids
Type: array of string
+

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

+
- -
-
-
-
-
+ No Additional Items

Each item of this array must be:

-
-

- -

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

+
Example:
+
[
+    "AHU-22"
+]
+
+
-
+
+
+
+
+
-
+

- +

-
+

Model Operation

Type: enum (of string)
- + config

Config Cloud Model

Type: object
+

Information specific to how the device communicates with the cloud.

+
-
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
+ No Additional Properties -
-
-
-
-
+
-
+

- +

-
+
Type: string
-

Strigified version of the metadata object, used for internal backend processing

+ config + + + + static_file
Type: string
+

Config file to use. Within the config directory in the device's metadata directory

@@ -24687,18 +21408,22 @@

-
+
+
+
+
+
-
+

- +

-
+
Type: object
-

If operating on the entire registry, then this contains results for multiple devices (batched operation).

-
+ blocked
Type: boolean
+ -
+
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[-._a-zA-Z0-9]+$ -
+
+
Type: object
+ detail
Type: string
@@ -24818,30 +21534,18 @@

-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+

- +

-
+
Type: object
-

Device iot cloud models

-
No Additional Properties + devices + + + + Cloud Model + + + + updated_time
Type: stringFormat: date-time
+ -
+
+
+
+
+
-
+

- +

-
-

- -

-

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]*$ -
+
+

Cloud Model

Type: object
-

Information specific to how the device communicates with the cloud.

-
+ Cloud Model + + + + last_state_time
Type: stringFormat: date-time
- No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
Type: integer
-

Function version of this request

-
+ last_config_time
Type: stringFormat: date-time
+ @@ -24994,18 +21717,18 @@

-
+
-
+

- +

-
+
Type: enum (of string)
-

The key type used for cloud communication.

-
-

Must be one of:

-
  • "ES256"
  • "ES256_X509"
  • "RS256"
  • "RS256_X509"
-
+ last_error_time
Type: stringFormat: date-time
+ @@ -25059,18 +21778,18 @@

Must be one of:

-
+
-
+

- +

-
+
Type: boolean
-

Indicates if the device private key is provided in the site model.

-
+ num_id
Type: string
+ @@ -25121,18 +21839,18 @@

-
+
-
+

- +

-
+
Type: enum (of string)
-

The cloud resource type

-

Model Operation

Type: enum (of string)
+ + +

Must be one of:

-
  • "DIRECT"
  • "GATEWAY"
  • "FUNNEL"
  • "PROXIED"
  • "REGISTRY"
+
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
@@ -25186,18 +21905,18 @@

Must be one of:

-
+
-
+

- +

-
+

Gateway Model

Type: object
-

Gateway Documentation

+ metadata_str
Type: string
+

Strigified version of the metadata object, used for internal backend processing

- - No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
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]*$ + device_ids
Type: object
+

If operating on the entire registry, then this contains results for multiple devices (batched operation).

+
-
-
Example:
-
"GAT-100"
-
-
-
-
-
-
-
+ +
-
+

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[-._a-zA-Z0-9]+$ +

Family Localnet Model

Type: object
-

The type of network

-
+ ^[-._a-zA-Z0-9]+$
Type: object
- No Additional Properties -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+

- +

-
+
Type: object
+

Information about a specific point name of the device.

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
+ + Type: string
-

The address of a device on the fieldbus/local network

+ Point Pointset Model

Point Pointset Model

Type: object
+

Information about a specific point name of the device.

+ + No Additional Properties -
-
Examples:
-
"192.168.1.3"
-
-
"41489"
-
-
-
-
-
-
-
+ +
-
+

- +

-
+
Type: string
-

The network designator for this device in the family-defined format

+ units
Type: string
+

Expected unit configuration for the point

-
-
Examples:
-
"192.168.1.0/24"
-
-
"12732"
-
-
+
-
+
-
+

- +

-
+
Type: object
- No Additional Properties + type
Type: enum (of string)
+

Expected data type for the point

+
+

Must be one of:

+
  • "string"
  • "boolean"
  • "number"
+
-
+
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+
Type: string
- + description
Type: string
+

Detailed description of this point

+
@@ -25708,22 +22401,18 @@

-
-
-
-
-
+
-
+

- +

-
+
Type: string
-

Specifies that this is a shadow of the indicated device

+ writable
Type: boolean
+

Indicates if this point is writable (else read-only)

@@ -25788,18 +22463,18 @@

-
+
-
+

- +

-
+
Type: string
-

The device id of the node's parent

+ baseline_value
Type: object
+

Represents the expected baseline value of the point

- +
+
Example:
+
22
+
+
-
+
-
+

- +

-
+
Type: string
-

The family designator, used only when the entry is not keyed in a family map

+ baseline_tolerance
Type: number
+

Maximum deviation from baseline_value

@@ -25936,28 +22587,26 @@


-
Examples:
-
"ipv4"
-
-
"bacnet"
+
Example:
+
2
 

-
+
-
+

- +

-
+
Type: string
-

The network within the gateway device to use for this network

-
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ - - - - - -
-
Examples:
-
"modbus_1"
-
-
"bacnet_1"
-
-
+ 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"
-
-
-
+ + + + + +
-
+
-
+

- +

-
+
Type: array of string
-

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

+ range_min
Type: number
+

Represents the lower bound of the error threshold for a point

- No Additional Items

Each item of this array must be:

+
+
Example:
+
0
+
+
+
+
+
+
+
-
- +
+

+ +

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

Represents the upper bound of the error threshold for a point

+
- -
-

+
Example:
-
[
-    "AHU-22"
-]
+
100
 
-
-
-
-
-
+
-
+

- +

-
+

Config Cloud Model

Type: object
-

Information specific to how the device communicates with the cloud.

+ unchanged_limit_sec
Type: integer
+

Represents the limit in seconds that a point can be unchanged for

- - No Additional Properties - -
+
+
Example:
+
3600
+
+
+
+
+
+
+
-
+

- +

-
+
Type: string
-

Config file to use. Within the config directory in the device's metadata directory

+ cov_increment
Type: number
+

Triggering threshold for partial cov update publishing

- -
-
-
+
+
Example:
+
1
+
-
+
-
+

- +

-
+
Type: boolean
- + ref
Type: string
+

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

+
- +
+
Examples:
+
"AI3"
+
+
"400070"
+
+
-
+
-
+

- +

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

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
Type: stringFormat: date-time
+ adjunct + + + + ^[a-z_]+$
Type: string
@@ -26490,18 +23122,22 @@

-
+
+
+
+
+
-
+

- +

-
+
Type: stringFormat: date-time
- + tags
Type: array
+

Tags assosciated with the point

+
- -
-
-
-
-
+

All items must be unique

No Additional Items

Each item of this array must be:

-
-

- -

-
- -
-
+
+ Type: stringFormat: date-time
- + tags + + + + tags items
Type: object
+Must match regular expression: ^[a-z0-9]+$ +
+

+
Examples:
+
[
+    "lighting"
+]
+
+
[
+    "energy",
+    "hvac"
+]
+
+
-
+
-
+

- +

-
+
Type: stringFormat: date-time
- + structure
Type: object
+

Collection of family point information

+
No Additional Properties -
-
-
-
-
+
-
+

- +

-
-
+
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
Type: string
+ structure + + + + Ref Discovery

Ref Discovery

Type: object
+

Object representation for for a single point reference discovery

+
+ No Additional Properties -
-
-
-
-
+
-
+

- +

-
+

Model Operation

Type: enum (of string)
- - -
-

Must be one of:

-
  • "ERROR"
  • "CREATE"
  • "READ"
  • "REPLY"
  • "UPDATE"
  • "DELETE"
  • "MODIFY"
  • "PREVIEW"
  • "BIND"
  • "UNBIND"
  • "BOUND"
  • "ALLOW"
  • "BLOCK"
-
+ structure + + + + Ref Discovery + + + + point
Type: string
+

Point descriptor for this point

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ @@ -26800,18 +23461,18 @@

Must be one of:

-
+
-
+

- +

-
+
Type: string
-

Strigified version of the metadata object, used for internal backend processing

+ structure + + + + Ref Discovery + + + + name
Type: string
+

Friendly name for the reference, if known

@@ -26862,18 +23537,18 @@

-
+
-
+

- +

-
+
Type: object
-

If operating on the entire registry, then this contains results for multiple devices (batched operation).

+ structure + + + + Ref Discovery + + + + possible_values
Type: array of string
+

List of possible enumerated values for the point

- -
+ No Additional Items

Each item of this array must be:

-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[-._a-zA-Z0-9]+$ -
+
+ Type: object
+ Ref Discovery + + + + possible_values + + + + possible_values items
Type: string
@@ -26989,34 +23677,24 @@

-

-
-
-
-
-
-
-
-
-
-
+
-
+

- +

-
+
Type: object
-

Information about a specific point name of the device.

-
No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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]+)*$ -
- -

Point Pointset Model

Type: object
-

Information about a specific point name of the device.

+ units
Type: string
+

Current or default unit for this point

- - No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
Type: string
-

Expected unit configuration for the point

+ structure + + + + Ref Discovery + + + + ref
Type: string
+

Family reference for structures

@@ -27169,18 +23835,18 @@

-
+
-
+

- +

-
+
Type: enum (of string)
-

Expected data type for the point

-
-

Must be one of:

-
  • "string"
  • "boolean"
  • "number"
-
+ structure + + + + Ref Discovery + + + + type
Type: string
+

Current or default type for this point

+
@@ -27234,18 +23911,18 @@

Must be one of:

-
+
-
+

- +

-
+
Type: string
-

Detailed description of this point

+ structure + + + + Ref Discovery + + + + writable
Type: boolean
+

Indicates if this point is writable or not

@@ -27296,18 +23987,18 @@

-
+
-
+

- +

-
+
Type: boolean
-

Indicates if this point is writable (else read-only)

+ structure + + + + Ref Discovery + + + + description
Type: string
+

Human-readable description of this point

@@ -27358,18 +24063,18 @@

-
+
-
+

- +

-
+
Type: object
-

Represents the expected baseline value of the point

-
+ structure + + + + Ref Discovery + + + + status

Entry

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

- +

-
+
Type: number
-

Maximum deviation from baseline_value

+ structure + + + + Ref Discovery + + + + status + + + + message
Type: string
+

A human-readable one-line description of the entry

@@ -27483,25 +24216,25 @@


Example:
-
2
+
"Point is not writable"
 

-
+
-
+

- +

-
+
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"
-
+ structure + + + + Ref Discovery + + + + status + + + + detail
Type: string
+

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

+
@@ -27555,18 +24306,18 @@

Must be one of:

-
+
-
+

- +

-
+
Type: number
-

Represents the lower bound of the error threshold for a point

-
- - - - + structure + + + + Ref Discovery + + + + status + + + + category

Category

Type: string
-
-
Example:
-
0
-
-
-
-
-
-
-
-
-
-

- -

-
-
-
+

+ +

+
+ Type: number
-

Represents the upper bound of the error threshold for a point

-
- - - - - -
-
Example:
-
100
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: integer
-

Represents the limit in seconds that a point can be unchanged for

-
+ item 0
Type: object
+Must match regular expression: ^system\.base\.start$ -
-
Example:
-
3600
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: number
-

Triggering threshold for partial cov update publishing

-
- - - - -
-
Example:
-
1
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

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

-
- - - - - -
-
Examples:
-
"AI3"
-
-
"400070"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
- No Additional Properties + item 1
Type: object
+Must match regular expression: ^system\.base\.shutdown$ -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+ Type: string
- - - - - - - -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: array
-

Tags assosciated with the point

-
+ item 2
Type: object
+Must match regular expression: ^system\.base\.ready$ -

All items must be unique

No Additional Items

Each item of this array must be:

-
-
+ +
Type: object
-Must match regular expression: ^[a-z0-9]+$ - - - - - - -
-

-
Examples:
-
[
-    "lighting"
-]
-
-
[
-    "energy",
-    "hvac"
-]
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
-

Collection of family point information

-
No Additional Properties + item 3
Type: object
+Must match regular expression: ^system\.config\.receive$ -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ -
+
+

Ref Discovery

Type: object
-

Object representation for for a single point reference discovery

-
- - No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-
- - Type: string
-

Point descriptor for this point

-
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + item 4
Type: object
+Must match regular expression: ^system\.config\.parse$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Friendly name for the reference, if known

-
+ status + + + + category + + + + oneOf + + + + item 5
Type: object
+Must match regular expression: ^system\.config\.apply$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: array of string
-

List of possible enumerated values for the point

-
+ status + + + + category + + + + oneOf + + + + item 6
Type: object
+Must match regular expression: ^system\.auth\.login$ - No Additional Items

Each item of this array must be:

-
-
+ +
Type: string
- + category + + + + oneOf + + + + item 7
Type: object
+Must match regular expression: ^system\.auth\.logout$ -
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Current or default unit for this point

-
+ status + + + + category + + + + oneOf + + + + item 8
Type: object
+Must match regular expression: ^system\.auth\.fail$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Family reference for structures

-
+ status + + + + category + + + + oneOf + + + + item 9
Type: object
+Must match regular expression: ^pointset\.point\.nominal$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Current or default type for this point

-
+ status + + + + category + + + + oneOf + + + + item 10
Type: object
+Must match regular expression: ^pointset\.point\.applied$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: boolean
-

Indicates if this point is writable or not

-
+ status + + + + category + + + + oneOf + + + + item 11
Type: object
+Must match regular expression: ^pointset\.point\.updating$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Human-readable description of this point

-
+ status + + + + category + + + + oneOf + + + + item 12
Type: object
+Must match regular expression: ^pointset\.point\.overridden$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+

Entry

Type: object
- - - No Additional Properties + status + + + + category + + + + oneOf + + + + item 13
Type: object
+Must match regular expression: ^pointset\.point\.failure$ -
-
-
-

- -

-
- -
-
+
+ Type: string
-

A human-readable one-line description of the entry

-
+ category + + + + oneOf + + + + item 14
Type: object
+Must match regular expression: ^pointset\.point\.invalid$ -
-
Example:
-
"Point is not writable"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+ +
+ Type: string
-

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

-
+ category + + + + oneOf + + + + item 15
Type: object
+Must match regular expression: ^alarmset\.alarm\.invalid$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+

Category

Type: string
+ category + + + + oneOf + + + + item 16
Type: object
+Must match regular expression: ^localnet\.network$ + + + -

- -

-
+ +
Type: object
-Must match regular expression: ^system\.base\.start$ + item 17
Type: object
+Must match regular expression: ^localnet\.network\.connect$ @@ -29545,7 +26049,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i18" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.shutdown$ + item 18
Type: object
+Must match regular expression: ^gateway\.setup\.attach$ @@ -29627,7 +26131,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i19" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.ready$ + item 19
Type: object
+Must match regular expression: ^gateway\.proxy\.target$ @@ -29709,7 +26213,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i20" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.receive$ + item 20
Type: object
+Must match regular expression: ^gateway\.proxy\.connect$ @@ -29791,7 +26295,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i21" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.parse$ + item 21
Type: object
+Must match regular expression: ^discovery\.family\.scan$ @@ -29873,7 +26377,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i22" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.apply$ + item 22
Type: object
+Must match regular expression: ^discovery\.device\.enumerate$ @@ -29955,7 +26459,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i23" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.login$ + item 23
Type: object
+Must match regular expression: ^discovery\.point\.describe$ @@ -30037,7 +26541,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i24" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.logout$ + item 24
Type: object
+Must match regular expression: ^mapping\.device\.apply$ @@ -30119,7 +26623,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i25" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.fail$ + item 25
Type: object
+Must match regular expression: ^blobset\.blob\.receive$ @@ -30201,7 +26705,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i26" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.nominal$ + item 26
Type: object
+Must match regular expression: ^blobset\.blob\.fetch$ @@ -30283,7 +26787,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i27" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.applied$ + item 27
Type: object
+Must match regular expression: ^blobset\.blob\.apply$ @@ -30365,7 +26869,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i28" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.updating$ + item 28
Type: object
+Must match regular expression: ^validation\.device\.receive$ @@ -30447,7 +26951,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i29" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.overridden$ + item 29
Type: object
+Must match regular expression: ^validation\.device\.schema$ @@ -30529,7 +27033,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i30" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.failure$ + item 30
Type: object
+Must match regular expression: ^validation\.device\.content$ @@ -30611,7 +27115,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i31" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.invalid$ + item 31
Type: object
+Must match regular expression: ^validation\.device\.multiple$ @@ -30693,7 +27197,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i32" role="tabpanel"> Type: object
-Must match regular expression: ^localnet\.network$ + item 32
Type: object
+Must match regular expression: ^validation\.device\.extra$ @@ -30775,7 +27279,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i33" role="tabpanel"> Type: object
-Must match regular expression: ^localnet\.network\.connect$ + item 33
Type: object
+Must match regular expression: ^validation\.summary\.report$ @@ -30857,7 +27361,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i34" role="tabpanel"> Type: object
-Must match regular expression: ^gateway\.setup\.attach$ + item 34
Type: object
+Must match regular expression: ^validation\.feature\.sequence$ @@ -30939,7 +27443,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i35" role="tabpanel"> Type: object
-Must match regular expression: ^gateway\.proxy\.target$ + item 35
Type: object
+Must match regular expression: ^validation\.feature\.schema$ @@ -31021,7 +27525,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i36" role="tabpanel"> Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ + item 36
Type: object
+Must match regular expression: ^validation\.feature\.capability$ @@ -31103,7 +27607,7 @@

+ id="tab-pane_structure_pattern1_points_pattern1_structure_pattern1_status_category_oneOf_i37" role="tabpanel"> Type: object
-Must match regular expression: ^discovery\.family\.scan$ + item 37
Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ -
- +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ + timestamp
Type: stringFormat: date-time
+

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

+
- -
- +
+
Example:
+
"2018-08-26T21:39:28.364Z"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^discovery\.point\.describe$ + 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

- -
- +
+
Example:
+
600
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+

Ancillary Properties

Type: object
+

Arbitrary blob of json associated with this point

+
+ + + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^mapping\.device\.apply$ + points + + + + Point Pointset Model + + + + structure + + + + Ref Discovery + + + + adjunct
Type: object
+ No Additional Properties -
- +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
Type: object
-Must match regular expression: ^blobset\.blob\.receive$ + ^[a-z_]+$
Type: string
+ -
- +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ + structure
Type: object
+ -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.apply$ + point

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ + No Additional Properties - -
- + +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.receive$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.schema$ + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.content$ + families
Type: object
+

Reference links to alternate families

+
No Additional Properties -
- +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
Type: object
-Must match regular expression: ^validation\.device\.multiple$ + Family Discovery

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.extra$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.summary\.report$ + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
+

Collection of point references

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ + Discovery Events + + + + refs + + + + Ref Discovery

Ref Discovery

Type: object
+

Object representation for for a single point reference discovery

+
+ + No Additional Properties -
+
+
+
+

+ +

+
+
+
Type: string
+

Point descriptor for this point

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^validation\.feature\.schema$ + name
Type: string
+

Friendly name for the reference, if known

+
+ +
+
+
+
+
+
+
+

+ +

+
-
- +
+
Type: array of string
+

List of possible enumerated values for the point

+
+ + + + + + No Additional Items

Each item of this array must be:

+
+
+ + + Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - + possible_values + + + + possible_values items
Type: string
+ + + -
+ +
+
+
+
+
+
+
+
+
+

+ +

+
+
+
Type: string
+

Current or default unit for this point

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ + ref
Type: string
+

Family reference for structures

+
-
- - - - - -
-
+
-
+

- +

-
+
Type: stringFormat: date-time
-

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

+ type
Type: string
+

Current or default type for this point

-
-
Example:
-
"2018-08-26T21:39:28.364Z"
-
-
+
-
+
-
+

- +

-
+
Type: boolean
+

Indicates if this point is writable or not

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + 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).

+ refs + + + + Ref Discovery + + + + description
Type: string
+

Human-readable description of this point

-

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

+ -
-
Example:
-
600
-
-
-
-
-
-
+
-
+
-
+

- +

-
+

Ancillary Properties

Type: object
-

Arbitrary blob of json associated with this point

-
+ status

Entry

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

- +

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

A human-readable one-line description of the entry

+
- -
+
+
Example:
+
"Point is not writable"
+
+
+
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+
Type: string
- + detail
Type: string
+

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

+
@@ -32921,22 +29768,18 @@

-
-
-
-
-
+
-
+

- +

-
+
Type: object
- - - - - + category

Category

Type: string
- -
-
-
-

- -

-
-
-
+

+ +

+
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties + item 0
Type: object
+Must match regular expression: ^system\.base\.start$ -
-
-
-

- -

-
- -
-
+
+ Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + item 1
Type: object
+Must match regular expression: ^system\.base\.shutdown$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + item 2
Type: object
+Must match regular expression: ^system\.base\.ready$ -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
-

Reference links to alternate families

-
No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-

- -

-

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]+)*$ -
+
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

-
- - No Additional Properties - - - - - + item 3
Type: object
+Must match regular expression: ^system\.config\.receive$ + -
-
-
-

- -

-
+ + -
-
+ +
+ Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - + item 4
Type: object
+Must match regular expression: ^system\.config\.parse$ + -
-
-
-
-
-
-
-

- -

-
+ + -
-
+ +
+ Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ - - - - - + item 5
Type: object
+Must match regular expression: ^system\.config\.apply$ + -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- -
-
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: object
-

Collection of point references

-
No Additional Properties + item 6
Type: object
+Must match regular expression: ^system\.auth\.login$ -
-
-
-

- -

-
- -
-

- -

-

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

- Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ -
+
+

Ref Discovery

Type: object
-

Object representation for for a single point reference discovery

-
- - No Additional Properties - - - - - - -
-
-
-

- -

-
- -
-
- - Type: string
-

Point descriptor for this point

-
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + item 7
Type: object
+Must match regular expression: ^system\.auth\.logout$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Friendly name for the reference, if known

-
+ status + + + + category + + + + oneOf + + + + item 8
Type: object
+Must match regular expression: ^system\.auth\.fail$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: array of string
-

List of possible enumerated values for the point

-
+ status + + + + category + + + + oneOf + + + + item 9
Type: object
+Must match regular expression: ^pointset\.point\.nominal$ - No Additional Items

Each item of this array must be:

-
-
+ +
Type: string
- + category + + + + oneOf + + + + item 10
Type: object
+Must match regular expression: ^pointset\.point\.applied$ -
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Current or default unit for this point

-
+ status + + + + category + + + + oneOf + + + + item 11
Type: object
+Must match regular expression: ^pointset\.point\.updating$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Family reference for structures

-
+ status + + + + category + + + + oneOf + + + + item 12
Type: object
+Must match regular expression: ^pointset\.point\.overridden$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Current or default type for this point

-
+ status + + + + category + + + + oneOf + + + + item 13
Type: object
+Must match regular expression: ^pointset\.point\.failure$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: boolean
-

Indicates if this point is writable or not

-
+ status + + + + category + + + + oneOf + + + + item 14
Type: object
+Must match regular expression: ^pointset\.point\.invalid$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+ Type: string
-

Human-readable description of this point

-
+ status + + + + category + + + + oneOf + + + + item 15
Type: object
+Must match regular expression: ^alarmset\.alarm\.invalid$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+

Entry

Type: object
- - - No Additional Properties + status + + + + category + + + + oneOf + + + + item 16
Type: object
+Must match regular expression: ^localnet\.network$ -
-
-
-

- -

-
- -
-
+
+ Type: string
-

A human-readable one-line description of the entry

-
+ category + + + + oneOf + + + + item 17
Type: object
+Must match regular expression: ^localnet\.network\.connect$ -
-
Example:
-
"Point is not writable"
-
-
-
-
-
-
-
-
-
-

- -

-
- -
-
+ +
+ Type: string
-

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

-
+ category + + + + oneOf + + + + item 18
Type: object
+Must match regular expression: ^gateway\.setup\.attach$ -
-
-
-
-
-
-
-

- -

-
- -
-
+
+

Category

Type: string
+ category + + + + oneOf + + + + item 19
Type: object
+Must match regular expression: ^gateway\.proxy\.target$ + + + -

- -

-
+ +
Type: object
-Must match regular expression: ^system\.base\.start$ + item 20
Type: object
+Must match regular expression: ^gateway\.proxy\.connect$ @@ -34892,7 +31449,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i21" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.shutdown$ + item 21
Type: object
+Must match regular expression: ^discovery\.family\.scan$ @@ -34960,7 +31517,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i22" role="tabpanel"> Type: object
-Must match regular expression: ^system\.base\.ready$ + item 22
Type: object
+Must match regular expression: ^discovery\.device\.enumerate$ @@ -35028,7 +31585,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i23" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.receive$ + item 23
Type: object
+Must match regular expression: ^discovery\.point\.describe$ @@ -35096,7 +31653,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i24" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.parse$ + item 24
Type: object
+Must match regular expression: ^mapping\.device\.apply$ @@ -35164,7 +31721,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i25" role="tabpanel"> Type: object
-Must match regular expression: ^system\.config\.apply$ + item 25
Type: object
+Must match regular expression: ^blobset\.blob\.receive$ @@ -35232,7 +31789,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i26" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.login$ + item 26
Type: object
+Must match regular expression: ^blobset\.blob\.fetch$ @@ -35300,7 +31857,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i27" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.logout$ + item 27
Type: object
+Must match regular expression: ^blobset\.blob\.apply$ @@ -35368,7 +31925,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i28" role="tabpanel"> Type: object
-Must match regular expression: ^system\.auth\.fail$ + item 28
Type: object
+Must match regular expression: ^validation\.device\.receive$ @@ -35436,7 +31993,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i29" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.nominal$ + item 29
Type: object
+Must match regular expression: ^validation\.device\.schema$ @@ -35504,7 +32061,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i30" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.applied$ + item 30
Type: object
+Must match regular expression: ^validation\.device\.content$ @@ -35572,7 +32129,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i31" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.updating$ + item 31
Type: object
+Must match regular expression: ^validation\.device\.multiple$ @@ -35640,7 +32197,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i32" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.overridden$ + item 32
Type: object
+Must match regular expression: ^validation\.device\.extra$ @@ -35708,7 +32265,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i33" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.failure$ + item 33
Type: object
+Must match regular expression: ^validation\.summary\.report$ @@ -35776,7 +32333,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i34" role="tabpanel"> Type: object
-Must match regular expression: ^pointset\.point\.invalid$ + item 34
Type: object
+Must match regular expression: ^validation\.feature\.sequence$ @@ -35844,7 +32401,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i35" role="tabpanel"> Type: object
-Must match regular expression: ^localnet\.network$ + item 35
Type: object
+Must match regular expression: ^validation\.feature\.schema$ @@ -35912,7 +32469,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i36" role="tabpanel"> Type: object
-Must match regular expression: ^localnet\.network\.connect$ + item 36
Type: object
+Must match regular expression: ^validation\.feature\.capability$ @@ -35980,7 +32537,7 @@

+ id="tab-pane_structure_pattern1_refs_pattern1_status_category_oneOf_i37" role="tabpanel"> Type: object
-Must match regular expression: ^gateway\.setup\.attach$ + item 37
Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ -
- +
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^gateway\.proxy\.target$ + timestamp
Type: stringFormat: date-time
+

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

+
- -
- +
+
Example:
+
"2018-08-26T21:39:28.364Z"
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
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

+ +
+
Example:
+
600
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ + Discovery Events + + + + refs + + + + Ref Discovery + + + + ancillary

Ancillary Properties

Type: object
+

Arbitrary blob of json associated with this point

+
+ + -
- +
+
+
+
+
+
+
+

+ +

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

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[a-z_]+$ +
+ + Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - - - -
- - - Type: string
+ + + + + + + +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ + structure
Type: object
+ -
- +
+
+
+

+ +

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

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^mapping\.device\.apply$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.receive$ + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ + families
Type: object
+

Reference links to alternate families

+
No Additional Properties -
- +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
Type: object
-Must match regular expression: ^blobset\.blob\.apply$ + Family Discovery

Family Discovery

Type: object
+

Discovery information for a protocol family.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.receive$ + addr
Type: string
+

Device addr in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^validation\.device\.schema$ + ref
Type: string
+

Point reference in the namespace of the given family

+
Must match regular expression: ^[-_.:0-9A-Z]+$ -
- +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + + + + + +
+
+
+

+ +

+
+ +
+
Type: object
+

Information about a specific alarm name of the device.

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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]+)*$ +
+ + Type: object
-Must match regular expression: ^validation\.device\.content$ + Alarm Alarmset Model

Alarm Alarmset Model

Type: object
+

Information about a specific alarm name of the device.

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - - - -
- - - Type: string
+

Category that this alarm is classified as

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^validation\.device\.extra$ + severity
Type: string
+

Severity of the alarm

+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - - - -
- - - Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ + return_requires_ack
Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
-
- +
+
+
+
+
+
+
+

+ +

+
+ +
+
Type: string
+

Mapping for the alarm to its internal counterpart

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

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

Collection of alarm information

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ + Type: object
-Must match regular expression: ^validation\.feature\.capability$ + Alarm Ref Discovery

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties -
- +
+
+
+

+ +

+
+ +
+
Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - - - - - - -
+ alarm
Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ @@ -37350,18 +34315,18 @@

-
+
-
+

- +

-
+
Type: stringFormat: date-time
-

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

+ Alarm Ref Discovery + + + + name
Type: string
+

Friendly name for the reference, if known

-
-
Example:
-
"2018-08-26T21:39:28.364Z"
-
-
+
-
+
-
+

- +

-
+
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).

+ Alarm Ref Discovery + + + + description
Type: string
+

Detailed description of this alarm

-

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

+ -
-
Example:
-
600
-
-
-
-
-
-
+
-
+
-
+

- +

-
+

Ancillary Properties

Type: object
-

Arbitrary blob of json associated with this point

+ structure + + + + Alarm Ref Discovery + + + + category
Type: string
+

Category that this alarm is classified as

- - @@ -37564,18 +34543,18 @@

-
+
-
+

- +

-
+
Type: object
- No Additional Properties + structure + + + + Alarm Ref Discovery + + + + severity
Type: string
+

Severity of the alarm

+
-
+
+
+
+
+
-
+

- +

-
-

- -

-

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

- Property name regular expression: ^[a-z_]+$ -
+
+
Type: string
- + Alarm Ref Discovery + + + + requires_ack
Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
@@ -37694,22 +34695,18 @@

-
-
-
-
-
+
-
+

- +

-
+
Type: object
- + structure + + + + Alarm Ref Discovery + + + + return_to_normal_event
Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
-
+
+
+
+
+
-
+

- +

-
+

Family Discovery

Type: object
-

Discovery information for a protocol family.

+ Alarm Ref Discovery + + + + return_requires_ack
Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

- - No Additional Properties -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+

- +

-
+
Type: object
+

Collection of alarm references

+
No Additional Properties + + + + + + +
+
+
+

+ +

+
+ +
+

+ +

+

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

+ Property name regular expression: ^[-_.:/a-zA-Z0-9]+$ +
+ + Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + Alarm Ref Discovery

Alarm Ref Discovery

Type: object
+

Object representation for for a single alarm reference discovery

+
+ + No Additional Properties -
-
-
-
-
+
-
+

- +

-
+
Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + alarm
Type: string
+

Alarm descriptor for this alarm

+
Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ @@ -37974,22 +35027,18 @@

-
-
-
-
-
+
-
+

- +

-
+
Type: object
-

Reference links to alternate families

-
No Additional Properties + name
Type: string
+

Friendly name for the reference, if known

+
-
+
+
+
+
+
-
+

- +

-
-

- -

-

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]+)*$ -
+
+
Type: string
+

Detailed description of this alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ +

Family Discovery

Type: object
-

Discovery information for a protocol family.

+ Discovery Events + + + + alarm_refs + + + + Alarm Ref Discovery + + + + category
Type: string
+

Category that this alarm is classified as

- - No Additional Properties -
+
+
+
+
+
-
+

- +

-
+
Type: string
+

Severity of the alarm

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Device addr in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + alarm_refs + + + + Alarm Ref Discovery + + + + requires_ack
Type: boolean
+

Indicates whether or not alarm activation requries acknowledgement.

+
@@ -38205,18 +35337,18 @@

-
+
-
+

- +

-
+
Type: boolean
+

Indicates whether or not the alarm sends return-to-normal events.

+
+ + + + + + +
+
+
+
+
+
+
+

+ +

+
+ +
+
+ + Type: string
-

Point reference in the namespace of the given family

-
Must match regular expression: ^[-_.:0-9A-Z]+$ + alarm_refs + + + + Alarm Ref Discovery + + + + return_requires_ack
Type: boolean
+

Indicates whether or not returning to normal requries acknowledgement.

+
-
-
-
-
-
-
-
-
-
-
-
-
@@ -39506,10 +36667,10 @@

network_id

Type: string

The network within the gateway device to use for this network

Must match regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$ + - - - + +
Examples:
diff --git a/gencode/docs/monitoring.html b/gencode/docs/monitoring.html index 5ff67ac31d..e0e04f6d5e 100644 --- a/gencode/docs/monitoring.html +++ b/gencode/docs/monitoring.html @@ -752,6 +752,11 @@

id="metric_system_logentries_items_category_oneOf_i36" data-toggle="tab" href="#tab-pane_metric_system_logentries_items_category_oneOf_i36" role="tab" onclick="setAnchor('#metric_system_logentries_items_category_oneOf_i36')" >Option 37 +
@@ -1722,7 +1727,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1783,7 +1788,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1844,7 +1849,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1905,7 +1910,7 @@

/> item 18

Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1966,7 +1971,7 @@

/> item 19

Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -2027,7 +2032,7 @@

/> item 20

Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -2088,7 +2093,7 @@

/> item 21

Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -2149,7 +2154,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -2210,7 +2215,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -2271,7 +2276,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -2332,7 +2337,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -2393,7 +2398,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -2454,7 +2459,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -2515,7 +2520,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -2576,7 +2581,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2637,7 +2642,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2698,7 +2703,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2759,7 +2764,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2820,7 +2825,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2881,7 +2886,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2942,7 +2947,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -3003,7 +3008,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/readme.md b/gencode/docs/readme.md index c36f55bda3..19faab6cba 100644 --- a/gencode/docs/readme.md +++ b/gencode/docs/readme.md @@ -7,7 +7,7 @@ ## Messages * [**config**](config.html) - The config block controls a device's intended behavior. [Config Documentation](../../docs/messages/config.md) -* [**events_alarmset**](events_alarmset.html) - A set of alarms reporting telemetry data. [Alarmset Events Documentation](../../docs/messages/alarmset.md#telemetry) +* [**events_alarmset**](events_alarmset.html) - A set of alarm events. * [**events_discovery**](events_discovery.html) - [Discovery result](../../docs/specs/discovery.md) with implicit discovery * [**events_pointset**](events_pointset.html) - A set of points reporting telemetry data. [Pointset Events Documentation](../../docs/messages/pointset.md#telemetry) * [**events_system**](events_system.html) - Used for system events such as logging. [System Event Documentation](../../docs/messages/system.md#event) diff --git a/gencode/docs/state.html b/gencode/docs/state.html index 4430ebfe56..30f6c9c06b 100644 --- a/gencode/docs/state.html +++ b/gencode/docs/state.html @@ -1282,6 +1282,11 @@

id="system_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_system_status_category_oneOf_i36" role="tab" onclick="setAnchor('#system_status_category_oneOf_i36')" >Option 37 +
@@ -2028,7 +2033,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -2075,7 +2080,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -2122,7 +2127,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -2169,7 +2174,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -2216,7 +2221,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -2263,7 +2268,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -2310,7 +2315,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -2357,7 +2362,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -2404,7 +2409,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -2451,7 +2456,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -2498,7 +2503,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -2545,7 +2550,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -2592,7 +2597,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -2639,7 +2644,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -2686,7 +2691,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2733,7 +2738,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2780,7 +2785,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2827,7 +2832,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2874,7 +2879,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2921,7 +2926,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2968,7 +2973,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -3015,7 +3020,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -3540,6 +3592,11 @@

id="gateway_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_gateway_status_category_oneOf_i36" role="tab" onclick="setAnchor('#gateway_status_category_oneOf_i36')" >Option 37 +
@@ -4286,7 +4343,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -4333,7 +4390,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -4380,7 +4437,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -4427,7 +4484,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -4474,7 +4531,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -4521,7 +4578,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -4568,7 +4625,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -4615,7 +4672,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -4662,7 +4719,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -4709,7 +4766,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -4756,7 +4813,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -4803,7 +4860,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -4850,7 +4907,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -4897,7 +4954,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -4944,7 +5001,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -4991,7 +5048,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -5038,7 +5095,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -5085,7 +5142,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -5132,7 +5189,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -5179,7 +5236,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -5226,7 +5283,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -5273,7 +5330,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -6293,6 +6397,11 @@

id="discovery_families_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_discovery_families_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#discovery_families_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -7263,7 +7372,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -7324,7 +7433,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -7385,7 +7494,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -7446,7 +7555,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -7507,7 +7616,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -7568,7 +7677,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -7629,7 +7738,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -7690,7 +7799,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -7751,7 +7860,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -7812,7 +7921,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -7873,7 +7982,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -7934,7 +8043,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -7995,7 +8104,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -8056,7 +8165,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -8117,7 +8226,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -8178,7 +8287,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -8239,7 +8348,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -8300,7 +8409,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -8361,7 +8470,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -8422,7 +8531,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -8483,7 +8592,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -8544,7 +8653,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -9300,6 +9470,11 @@

id="localnet_families_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_localnet_families_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#localnet_families_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -10270,7 +10445,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -10331,7 +10506,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -10392,7 +10567,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -10453,7 +10628,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -10514,7 +10689,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -10575,7 +10750,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -10636,7 +10811,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -10697,7 +10872,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -10758,7 +10933,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -10819,7 +10994,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -10880,7 +11055,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -10941,7 +11116,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -11002,7 +11177,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -11063,7 +11238,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -11124,7 +11299,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -11185,7 +11360,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -11246,7 +11421,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -11307,7 +11482,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -11368,7 +11543,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -11429,7 +11604,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -11490,7 +11665,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -11551,7 +11726,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -11743,12 +11979,12 @@

networks

Type: object
No Additional Properties + + + - - - - +
@@ -11793,12 +12029,12 @@

No Additional Properties + + + - - - - +
@@ -11843,12 +12079,12 @@

addr

Type: string
+ + + - - - - +

@@ -11899,12 +12135,12 @@

No Additional Properties + + + - - - - +
@@ -11957,10 +12193,10 @@

message

Type: string

A human-readable one-line description of the entry

+ - - - + +
Example:
@@ -12023,12 +12259,12 @@

detail

Type: string

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

+ + + - - - - +

@@ -12272,10 +12508,15 @@

id="localnet_networks_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_localnet_networks_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#localnet_networks_pattern1_status_category_oneOf_i36')" >Option 37 +
- + Type: object
Must match regular expression: ^system\.base\.start$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.shutdown$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.ready$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.receive$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.parse$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.apply$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.login$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.logout$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.fail$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.nominal$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.applied$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.updating$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.overridden$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.failure$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.invalid$ + + + - - - - +
- + Type: object
-Must match regular expression: ^localnet\.network$ - - - - +Must match regular expression: ^alarmset\.alarm\.invalid$ + + + +
- + Type: object
-Must match regular expression: ^localnet\.network\.connect$ - - - - +Must match regular expression: ^localnet\.network$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.setup\.attach$ - - - - +Must match regular expression: ^localnet\.network\.connect$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.target$ - - - - +Must match regular expression: ^gateway\.setup\.attach$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ - - - - +Must match regular expression: ^gateway\.proxy\.target$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - +Must match regular expression: ^gateway\.proxy\.connect$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ - - - - +Must match regular expression: ^discovery\.family\.scan$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.point\.describe$ - - - - +Must match regular expression: ^discovery\.device\.enumerate$ + + + +
- + Type: object
-Must match regular expression: ^mapping\.device\.apply$ - - - - +Must match regular expression: ^discovery\.point\.describe$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.receive$ - - - - +Must match regular expression: ^mapping\.device\.apply$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ - - - - +Must match regular expression: ^blobset\.blob\.receive$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.apply$ - - - - +Must match regular expression: ^blobset\.blob\.fetch$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.receive$ - - - - +Must match regular expression: ^blobset\.blob\.apply$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.schema$ - - - - +Must match regular expression: ^validation\.device\.receive$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.content$ - - - - +Must match regular expression: ^validation\.device\.schema$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - +Must match regular expression: ^validation\.device\.content$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.extra$ - - - - +Must match regular expression: ^validation\.device\.multiple$ + + + +
- + Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - +Must match regular expression: ^validation\.device\.extra$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ - - - - +Must match regular expression: ^validation\.summary\.report$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.schema$ - - - - +Must match regular expression: ^validation\.feature\.sequence$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - - +Must match regular expression: ^validation\.feature\.schema$ + + + +
- + Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - +Must match regular expression: ^validation\.feature\.capability$ + + + + +
+ + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ + + + +
+ + + - - - - + @@ -14593,10 +14895,10 @@

timestampType: stringFormat: date-time

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

+ - - - + +
Example:
@@ -14659,9 +14961,9 @@

levelType: 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


@@ -15285,6 +15587,11 @@

id="blobset_blobs_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_blobset_blobs_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#blobset_blobs_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -16255,7 +16562,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -16316,7 +16623,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -16377,7 +16684,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -16438,7 +16745,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -16499,7 +16806,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -16560,7 +16867,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -16621,7 +16928,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -16682,7 +16989,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -16743,7 +17050,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -16804,7 +17111,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -16865,7 +17172,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -16926,7 +17233,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -16987,7 +17294,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -17048,7 +17355,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -17109,7 +17416,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -17170,7 +17477,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -17231,7 +17538,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -17292,7 +17599,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -17353,7 +17660,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -17414,7 +17721,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -17475,7 +17782,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -17536,7 +17843,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -17787,12 +18155,12 @@

No Additional Properties + + + - - - - +
@@ -17824,10 +18192,10 @@

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:
@@ -17869,12 +18237,12 @@

version

Type: string

Version of the UDMI schema, not included in messages published by devices

+ + + - - - - +

@@ -17910,12 +18278,12 @@

state_etagType: 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

- + @@ -17953,12 +18321,12 @@

No Additional Properties + + + - - - - +
@@ -17997,10 +18365,10 @@

message

Type: string

A human-readable one-line description of the entry

+ - - - + +
Example:
@@ -18049,12 +18417,12 @@

detail

Type: string

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

+ + + - - - - +
@@ -18284,10 +18652,15 @@

id="alarmset_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_alarmset_status_category_oneOf_i36" role="tab" onclick="setAnchor('#alarmset_status_category_oneOf_i36')" >Option 37 +
- + Type: object
Must match regular expression: ^system\.base\.start$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.shutdown$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.ready$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.receive$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.parse$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.apply$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.login$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.logout$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.fail$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.nominal$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.applied$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.updating$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.overridden$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.failure$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.invalid$ + + + - - - - +
- + Type: object
-Must match regular expression: ^localnet\.network$ - - - - +Must match regular expression: ^alarmset\.alarm\.invalid$ + + + +
- + Type: object
-Must match regular expression: ^localnet\.network\.connect$ - - - - +Must match regular expression: ^localnet\.network$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.setup\.attach$ - - - - +Must match regular expression: ^localnet\.network\.connect$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.target$ - - - - +Must match regular expression: ^gateway\.setup\.attach$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ - - - - +Must match regular expression: ^gateway\.proxy\.target$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - +Must match regular expression: ^gateway\.proxy\.connect$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ - - - - +Must match regular expression: ^discovery\.family\.scan$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.point\.describe$ - - - - +Must match regular expression: ^discovery\.device\.enumerate$ + + + +
- + Type: object
-Must match regular expression: ^mapping\.device\.apply$ - - - - +Must match regular expression: ^discovery\.point\.describe$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.receive$ - - - - +Must match regular expression: ^mapping\.device\.apply$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ - - - - +Must match regular expression: ^blobset\.blob\.receive$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.apply$ - - - - +Must match regular expression: ^blobset\.blob\.fetch$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.receive$ - - - - +Must match regular expression: ^blobset\.blob\.apply$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.schema$ - - - - +Must match regular expression: ^validation\.device\.receive$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.content$ - - - - +Must match regular expression: ^validation\.device\.schema$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - +Must match regular expression: ^validation\.device\.content$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.extra$ - - - - +Must match regular expression: ^validation\.device\.multiple$ + + + +
- + Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - +Must match regular expression: ^validation\.device\.extra$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ - - - - +Must match regular expression: ^validation\.summary\.report$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.schema$ - - - - +Must match regular expression: ^validation\.feature\.sequence$ + + + +
- + Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - - +Must match regular expression: ^validation\.feature\.schema$ + + + +
- + Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - +Must match regular expression: ^validation\.feature\.capability$ + + + + +
+ + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ + + + +
+ + + - - - - + @@ -20073,10 +20493,10 @@

timestampType: stringFormat: date-time

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

+ - - - + +
Example:
@@ -20125,9 +20545,9 @@

levelType: 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


@@ -20174,12 +20594,12 @@

alarmsType: object

Collection of alarm names, defining the representative alarm set for this device.

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

No Additional Properties + + + - - - - -
-
-
-

- -

-
- -
-
- - Type: string
-

If specified, indicates a programmed alarm unit. If empty, means unspecified or matches configured alarm.

-
- - - - - - -
-
-
-
-
-
-
-

- -

-
- -
-
- - Type: enum (of string)
-

State of the individual alarm

-
-

Must be one of:

-
  • "initializing"
  • "applied"
  • "updating"
  • "overridden"
  • "invalid"
  • "failure"
-
- - - - - - -
-
-
-
+
@@ -20391,12 +20698,12 @@

No Additional Properties + + + - - - - +
@@ -20449,10 +20756,10 @@

message

Type: string

A human-readable one-line description of the entry

+ - - - + +
Example:
@@ -20515,12 +20822,12 @@

detail

Type: string

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

+ + + - - - - +

@@ -20764,10 +21071,15 @@

id="alarmset_alarms_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#alarmset_alarms_pattern1_status_category_oneOf_i36')" >Option 37 +
- + Type: object
Must match regular expression: ^system\.base\.start$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.shutdown$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.base\.ready$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.receive$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.parse$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.config\.apply$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.login$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.logout$ + + + - - - - +
- + Type: object
Must match regular expression: ^system\.auth\.fail$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.nominal$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.applied$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.updating$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.overridden$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.failure$ + + + - - - - +
- + Type: object
Must match regular expression: ^pointset\.point\.invalid$ + + + - - - - +
- + Type: object
-Must match regular expression: ^localnet\.network$ - - - - +Must match regular expression: ^alarmset\.alarm\.invalid$ + + + +
- + Type: object
-Must match regular expression: ^localnet\.network\.connect$ - - - - +Must match regular expression: ^localnet\.network$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.setup\.attach$ - - - - +Must match regular expression: ^localnet\.network\.connect$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.target$ - - - - +Must match regular expression: ^gateway\.setup\.attach$ + + + +
- + Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ - - - - +Must match regular expression: ^gateway\.proxy\.target$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.family\.scan$ - - - - +Must match regular expression: ^gateway\.proxy\.connect$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ - - - - +Must match regular expression: ^discovery\.family\.scan$ + + + +
- + Type: object
-Must match regular expression: ^discovery\.point\.describe$ - - - - +Must match regular expression: ^discovery\.device\.enumerate$ + + + +
- + Type: object
-Must match regular expression: ^mapping\.device\.apply$ - - - - +Must match regular expression: ^discovery\.point\.describe$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.receive$ - - - - +Must match regular expression: ^mapping\.device\.apply$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ - - - - +Must match regular expression: ^blobset\.blob\.receive$ + + + +
- + Type: object
-Must match regular expression: ^blobset\.blob\.apply$ - - - - +Must match regular expression: ^blobset\.blob\.fetch$ + + + +
- + Type: object
-Must match regular expression: ^validation\.device\.receive$ - - - - +Must match regular expression: ^blobset\.blob\.apply$ + + + +
+ + + Type: object
+Must match regular expression: ^validation\.device\.receive$ + + + + + +
+ Type: object
-Must match regular expression: ^validation\.device\.schema$ - - - - + item 29
Type: object
+Must match regular expression: ^validation\.device\.schema$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i30" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.content$ - - - - + item 30
Type: object
+Must match regular expression: ^validation\.device\.content$ + + + +

- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i31" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.multiple$ - - - - + item 31
Type: object
+Must match regular expression: ^validation\.device\.multiple$ + + + +

- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i32" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.device\.extra$ - - - - + item 32
Type: object
+Must match regular expression: ^validation\.device\.extra$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i33" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.summary\.report$ - - - - + item 33
Type: object
+Must match regular expression: ^validation\.summary\.report$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i34" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.sequence$ - - - - + item 34
Type: object
+Must match regular expression: ^validation\.feature\.sequence$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i35" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.schema$ - - - - + item 35
Type: object
+Must match regular expression: ^validation\.feature\.schema$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i36" role="tabpanel"> + Type: object
-Must match regular expression: ^validation\.feature\.capability$ - - - - + item 36
Type: object
+Must match regular expression: ^validation\.feature\.capability$ + + + +
- + id="tab-pane_alarmset_alarms_pattern1_status_category_oneOf_i37" role="tabpanel"> + Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ - - - - + item 37
Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ + + + + + + + - - - - + @@ -23085,10 +23458,10 @@

timestampType: stringFormat: date-time

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

+ - - - + +
Example:
@@ -23151,9 +23524,9 @@

levelType: 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


@@ -23208,12 +23581,12 @@

upgraded_fromType: string

Original version of schema pre-upgrade

+ + + - - - - + @@ -23659,6 +24032,11 @@

id="pointset_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_pointset_status_category_oneOf_i36" role="tab" onclick="setAnchor('#pointset_status_category_oneOf_i36')" >Option 37 +
@@ -24405,7 +24783,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -24452,7 +24830,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -24499,7 +24877,7 @@

/> item 17Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -24546,7 +24924,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -24593,7 +24971,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -24640,7 +25018,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -24687,7 +25065,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -24734,7 +25112,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -24781,7 +25159,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -24828,7 +25206,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -24875,7 +25253,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -24922,7 +25300,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -24969,7 +25347,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -25016,7 +25394,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -25063,7 +25441,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -25110,7 +25488,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -25157,7 +25535,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -25204,7 +25582,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -25251,7 +25629,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -25298,7 +25676,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -25345,7 +25723,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -25392,7 +25770,54 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -26139,6 +26564,11 @@

id="pointset_points_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_pointset_points_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#pointset_points_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -27109,7 +27539,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -27170,7 +27600,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -27231,7 +27661,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -27292,7 +27722,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -27353,7 +27783,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -27414,7 +27844,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -27475,7 +27905,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -27536,7 +27966,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -27597,7 +28027,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -27658,7 +28088,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -27719,7 +28149,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -27780,7 +28210,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -27841,7 +28271,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -27902,7 +28332,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -27963,7 +28393,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -28024,7 +28454,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -28085,7 +28515,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -28146,7 +28576,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -28207,7 +28637,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -28268,7 +28698,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -28329,7 +28759,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -28390,7 +28820,68 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/state_mapping.html b/gencode/docs/state_mapping.html index 8af8187831..835a35f775 100644 --- a/gencode/docs/state_mapping.html +++ b/gencode/docs/state_mapping.html @@ -782,6 +782,11 @@

id="devices_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_devices_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#devices_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -1640,7 +1645,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1694,7 +1699,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1748,7 +1753,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1802,7 +1807,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1856,7 +1861,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1910,7 +1915,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1964,7 +1969,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -2018,7 +2023,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -2072,7 +2077,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -2126,7 +2131,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -2180,7 +2185,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -2234,7 +2239,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -2288,7 +2293,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -2342,7 +2347,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -2396,7 +2401,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2450,7 +2455,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2504,7 +2509,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2558,7 +2563,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2612,7 +2617,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2666,7 +2671,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2720,7 +2725,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -2774,7 +2779,61 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/docs/state_validation.html b/gencode/docs/state_validation.html index 34613a9d0b..03796e6baf 100644 --- a/gencode/docs/state_validation.html +++ b/gencode/docs/state_validation.html @@ -1018,6 +1018,11 @@

id="status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_status_category_oneOf_i36" role="tab" onclick="setAnchor('#status_category_oneOf_i36')" >Option 37 +
@@ -1652,7 +1657,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -1692,7 +1697,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -1732,7 +1737,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -1772,7 +1777,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -1812,7 +1817,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -1852,7 +1857,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -1892,7 +1897,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -1932,7 +1937,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -1972,7 +1977,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -2012,7 +2017,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -2052,7 +2057,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -2092,7 +2097,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -2132,7 +2137,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -2172,7 +2177,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -2212,7 +2217,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -2252,7 +2257,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -2292,7 +2297,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -2332,7 +2337,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -2372,7 +2377,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -2412,7 +2417,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -2452,7 +2457,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -2492,7 +2497,47 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -3772,6 +3817,11 @@

id="features_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_features_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#features_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -5078,7 +5128,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -5160,7 +5210,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -5242,7 +5292,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -5324,7 +5374,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -5406,7 +5456,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -5488,7 +5538,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -5570,7 +5620,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -5652,7 +5702,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -5734,7 +5784,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -5816,7 +5866,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -5898,7 +5948,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -5980,7 +6030,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -6062,7 +6112,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -6144,7 +6194,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -6226,7 +6276,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -6308,7 +6358,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -6390,7 +6440,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -6472,7 +6522,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -6554,7 +6604,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -6636,7 +6686,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -6718,7 +6768,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -6800,7 +6850,89 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -7665,6 +7797,11 @@

id="features_pattern1_sequences_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_features_pattern1_sequences_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#features_pattern1_sequences_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -8747,7 +8884,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -8815,7 +8952,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -8883,7 +9020,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -8951,7 +9088,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -9019,7 +9156,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -9087,7 +9224,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -9155,7 +9292,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -9223,7 +9360,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -9291,7 +9428,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -9359,7 +9496,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -9427,7 +9564,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -9495,7 +9632,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -9563,7 +9700,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -9631,7 +9768,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -9699,7 +9836,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -9767,7 +9904,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -9835,7 +9972,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -9903,7 +10040,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -9971,7 +10108,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -10039,7 +10176,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -10107,7 +10244,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -10175,7 +10312,75 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -11830,6 +12035,11 @@

id="schemas_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_schemas_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#schemas_pattern1_sequences_pattern1_capabilities_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -13136,7 +13346,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -13218,7 +13428,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -13300,7 +13510,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -13382,7 +13592,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -13464,7 +13674,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -13546,7 +13756,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -13628,7 +13838,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -13710,7 +13920,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -13792,7 +14002,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -13874,7 +14084,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -13956,7 +14166,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -14038,7 +14248,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -14120,7 +14330,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -14202,7 +14412,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -14284,7 +14494,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -14366,7 +14576,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -14448,7 +14658,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -14530,7 +14740,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -14612,7 +14822,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -14694,7 +14904,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -14776,7 +14986,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -14858,7 +15068,89 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -15723,6 +16015,11 @@

id="schemas_pattern1_sequences_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_schemas_pattern1_sequences_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#schemas_pattern1_sequences_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -16805,7 +17102,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -16873,7 +17170,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -16941,7 +17238,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -17009,7 +17306,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -17077,7 +17374,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -17145,7 +17442,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -17213,7 +17510,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -17281,7 +17578,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -17349,7 +17646,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -17417,7 +17714,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -17485,7 +17782,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -17553,7 +17850,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -17621,7 +17918,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -17689,7 +17986,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -17757,7 +18054,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -17825,7 +18122,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -17893,7 +18190,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -17961,7 +18258,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -18029,7 +18326,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -18097,7 +18394,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -18165,7 +18462,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -18233,7 +18530,75 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ @@ -19507,6 +19872,11 @@

id="devices_pattern1_status_category_oneOf_i36" data-toggle="tab" href="#tab-pane_devices_pattern1_status_category_oneOf_i36" role="tab" onclick="setAnchor('#devices_pattern1_status_category_oneOf_i36')" >Option 37 +
@@ -20365,7 +20735,7 @@

/> item 15

Type: object
-Must match regular expression: ^localnet\.network$ +Must match regular expression: ^alarmset\.alarm\.invalid$ @@ -20419,7 +20789,7 @@

/> item 16

Type: object
-Must match regular expression: ^localnet\.network\.connect$ +Must match regular expression: ^localnet\.network$ @@ -20473,7 +20843,7 @@

/> item 17

Type: object
-Must match regular expression: ^gateway\.setup\.attach$ +Must match regular expression: ^localnet\.network\.connect$ @@ -20527,7 +20897,7 @@

/> item 18Type: object
-Must match regular expression: ^gateway\.proxy\.target$ +Must match regular expression: ^gateway\.setup\.attach$ @@ -20581,7 +20951,7 @@

/> item 19Type: object
-Must match regular expression: ^gateway\.proxy\.connect$ +Must match regular expression: ^gateway\.proxy\.target$ @@ -20635,7 +21005,7 @@

/> item 20Type: object
-Must match regular expression: ^discovery\.family\.scan$ +Must match regular expression: ^gateway\.proxy\.connect$ @@ -20689,7 +21059,7 @@

/> item 21Type: object
-Must match regular expression: ^discovery\.device\.enumerate$ +Must match regular expression: ^discovery\.family\.scan$ @@ -20743,7 +21113,7 @@

/> item 22Type: object
-Must match regular expression: ^discovery\.point\.describe$ +Must match regular expression: ^discovery\.device\.enumerate$ @@ -20797,7 +21167,7 @@

/> item 23Type: object
-Must match regular expression: ^mapping\.device\.apply$ +Must match regular expression: ^discovery\.point\.describe$ @@ -20851,7 +21221,7 @@

/> item 24Type: object
-Must match regular expression: ^blobset\.blob\.receive$ +Must match regular expression: ^mapping\.device\.apply$ @@ -20905,7 +21275,7 @@

/> item 25Type: object
-Must match regular expression: ^blobset\.blob\.fetch$ +Must match regular expression: ^blobset\.blob\.receive$ @@ -20959,7 +21329,7 @@

/> item 26Type: object
-Must match regular expression: ^blobset\.blob\.apply$ +Must match regular expression: ^blobset\.blob\.fetch$ @@ -21013,7 +21383,7 @@

/> item 27Type: object
-Must match regular expression: ^validation\.device\.receive$ +Must match regular expression: ^blobset\.blob\.apply$ @@ -21067,7 +21437,7 @@

/> item 28Type: object
-Must match regular expression: ^validation\.device\.schema$ +Must match regular expression: ^validation\.device\.receive$ @@ -21121,7 +21491,7 @@

/> item 29Type: object
-Must match regular expression: ^validation\.device\.content$ +Must match regular expression: ^validation\.device\.schema$ @@ -21175,7 +21545,7 @@

/> item 30Type: object
-Must match regular expression: ^validation\.device\.multiple$ +Must match regular expression: ^validation\.device\.content$ @@ -21229,7 +21599,7 @@

/> item 31Type: object
-Must match regular expression: ^validation\.device\.extra$ +Must match regular expression: ^validation\.device\.multiple$ @@ -21283,7 +21653,7 @@

/> item 32Type: object
-Must match regular expression: ^validation\.summary\.report$ +Must match regular expression: ^validation\.device\.extra$ @@ -21337,7 +21707,7 @@

/> item 33Type: object
-Must match regular expression: ^validation\.feature\.sequence$ +Must match regular expression: ^validation\.summary\.report$ @@ -21391,7 +21761,7 @@

/> item 34Type: object
-Must match regular expression: ^validation\.feature\.schema$ +Must match regular expression: ^validation\.feature\.sequence$ @@ -21445,7 +21815,7 @@

/> item 35Type: object
-Must match regular expression: ^validation\.feature\.capability$ +Must match regular expression: ^validation\.feature\.schema$ @@ -21499,7 +21869,61 @@

/> item 36Type: object
-Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ +Must match regular expression: ^validation\.feature\.capability$ + + + + + + +
+ + + Type: object
+Must match regular expression: ^device(\.[a-z]+((_[a-z]+))*)+$ diff --git a/gencode/java/udmi/schema/AlarmAcknowledgement.java b/gencode/java/udmi/schema/AlarmAcknowledgement.java new file mode 100644 index 0000000000..769989a71f --- /dev/null +++ b/gencode/java/udmi/schema/AlarmAcknowledgement.java @@ -0,0 +1,69 @@ + +package udmi.schema; + +import java.util.Date; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyDescription; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +/** + * Alarm Acknowledgement + *

+ * Details about an alarm acknowledgement + * + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonPropertyOrder({ + "timestamp", + "user", + "comment" +}) +public class AlarmAcknowledgement { + + /** + * Timestamp of when the alarm was acknowledged. + * (Required) + * + */ + @JsonProperty("timestamp") + @JsonPropertyDescription("Timestamp of when the alarm was acknowledged.") + public Date timestamp; + /** + * Name of the user who acknowledged this alarm. + * + */ + @JsonProperty("user") + @JsonPropertyDescription("Name of the user who acknowledged this alarm.") + public String user; + /** + * Comment left by the user when acknowledging this alarm. + * + */ + @JsonProperty("comment") + @JsonPropertyDescription("Comment left by the user when acknowledging this alarm.") + public String comment; + + @Override + public int hashCode() { + int result = 1; + result = ((result* 31)+((this.user == null)? 0 :this.user.hashCode())); + result = ((result* 31)+((this.comment == null)? 0 :this.comment.hashCode())); + result = ((result* 31)+((this.timestamp == null)? 0 :this.timestamp.hashCode())); + return result; + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if ((other instanceof AlarmAcknowledgement) == false) { + return false; + } + AlarmAcknowledgement rhs = ((AlarmAcknowledgement) other); + return ((((this.user == rhs.user)||((this.user!= null)&&this.user.equals(rhs.user)))&&((this.comment == rhs.comment)||((this.comment!= null)&&this.comment.equals(rhs.comment))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp)))); + } + +} diff --git a/gencode/java/udmi/schema/AlarmAlarmsetConfig.java b/gencode/java/udmi/schema/AlarmAlarmsetConfig.java index 747d59bbb3..8cc2fe4e83 100644 --- a/gencode/java/udmi/schema/AlarmAlarmsetConfig.java +++ b/gencode/java/udmi/schema/AlarmAlarmsetConfig.java @@ -1,7 +1,6 @@ package udmi.schema; -import java.util.Date; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyDescription; @@ -11,63 +10,27 @@ /** * Alarm Alarmset Config *

- * - * + * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ - "ref", - "units", - "set_value", - "stop_time", - "cov_increment" + "ref" }) public class AlarmAlarmsetConfig { /** - * Mapping for the alarm to an internal resource (e.g. BACnet object reference) - * + * Mapping for the alarm to its internal counterpart + * */ @JsonProperty("ref") - @JsonPropertyDescription("Mapping for the alarm to an internal resource (e.g. BACnet object reference)") + @JsonPropertyDescription("Mapping for the alarm to its internal counterpart") public String ref; - /** - * If specified, indicates the units the device should report the data in. - * - */ - @JsonProperty("units") - @JsonPropertyDescription("If specified, indicates the units the device should report the data in.") - public String units; - /** - * Used for cloud writeback functionality, this field specifies the value for a given alarm in the device's current units. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer - * - */ - @JsonProperty("set_value") - @JsonPropertyDescription("Used for cloud writeback functionality, this field specifies the value for a given alarm in the device's current units. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer") - public Object set_value; - /** - * RFC 3339 timestamp for the specified alarm write easing to stop - * - */ - @JsonProperty("stop_time") - @JsonPropertyDescription("RFC 3339 timestamp for the specified alarm write easing to stop") - public Date stop_time; - /** - * The CoV (change of value) increment, which when set, enables CoV on the alarm and defines the minimum change in present value of the respective alarm before an update is published - * - */ - @JsonProperty("cov_increment") - @JsonPropertyDescription("The CoV (change of value) increment, which when set, enables CoV on the alarm and defines the minimum change in present value of the respective alarm before an update is published") - public Double cov_increment; @Override public int hashCode() { int result = 1; result = ((result* 31)+((this.ref == null)? 0 :this.ref.hashCode())); - result = ((result* 31)+((this.units == null)? 0 :this.units.hashCode())); - result = ((result* 31)+((this.stop_time == null)? 0 :this.stop_time.hashCode())); - result = ((result* 31)+((this.set_value == null)? 0 :this.set_value.hashCode())); - result = ((result* 31)+((this.cov_increment == null)? 0 :this.cov_increment.hashCode())); return result; } @@ -80,7 +43,7 @@ public boolean equals(Object other) { return false; } AlarmAlarmsetConfig rhs = ((AlarmAlarmsetConfig) other); - return ((((((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref)))&&((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units))))&&((this.stop_time == rhs.stop_time)||((this.stop_time!= null)&&this.stop_time.equals(rhs.stop_time))))&&((this.set_value == rhs.set_value)||((this.set_value!= null)&&this.set_value.equals(rhs.set_value))))&&((this.cov_increment == rhs.cov_increment)||((this.cov_increment!= null)&&this.cov_increment.equals(rhs.cov_increment)))); + return ((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref))); } } diff --git a/gencode/java/udmi/schema/AlarmAlarmsetEvents.java b/gencode/java/udmi/schema/AlarmAlarmsetEvents.java index e41cb88f6f..8011139fde 100644 --- a/gencode/java/udmi/schema/AlarmAlarmsetEvents.java +++ b/gencode/java/udmi/schema/AlarmAlarmsetEvents.java @@ -1,6 +1,7 @@ package udmi.schema; +import java.util.Date; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyDescription; @@ -11,27 +12,68 @@ * Alarm Alarmset Events *

* Object representation for for a single alarm - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ - "present_value" + "activate_time", + "activate_ack", + "active", + "return_to_normal_time", + "return_to_normal_ack" }) public class AlarmAlarmsetEvents { /** - * The specific alarm data reading. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer + * Timestamp of when the alarm became active. * (Required) - * + * */ - @JsonProperty("present_value") - @JsonPropertyDescription("The specific alarm data reading. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer") - public Object present_value; + @JsonProperty("activate_time") + @JsonPropertyDescription("Timestamp of when the alarm became active.") + public Date activate_time; + /** + * Alarm Acknowledgement + *

+ * Details about an alarm acknowledgement + * + */ + @JsonProperty("activate_ack") + @JsonPropertyDescription("Details about an alarm acknowledgement") + public AlarmAcknowledgement activate_ack; + /** + * Indicates whether or not the alarm conditions are currently active. + * (Required) + * + */ + @JsonProperty("active") + @JsonPropertyDescription("Indicates whether or not the alarm conditions are currently active.") + public Boolean active; + /** + * Timestamp of when the alarm conditions returned to normal. + * + */ + @JsonProperty("return_to_normal_time") + @JsonPropertyDescription("Timestamp of when the alarm conditions returned to normal.") + public Date return_to_normal_time; + /** + * Alarm Acknowledgement + *

+ * Details about an alarm acknowledgement + * + */ + @JsonProperty("return_to_normal_ack") + @JsonPropertyDescription("Details about an alarm acknowledgement") + public AlarmAcknowledgement return_to_normal_ack; @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.present_value == null)? 0 :this.present_value.hashCode())); + result = ((result* 31)+((this.return_to_normal_time == null)? 0 :this.return_to_normal_time.hashCode())); + result = ((result* 31)+((this.active == null)? 0 :this.active.hashCode())); + result = ((result* 31)+((this.activate_time == null)? 0 :this.activate_time.hashCode())); + result = ((result* 31)+((this.activate_ack == null)? 0 :this.activate_ack.hashCode())); + result = ((result* 31)+((this.return_to_normal_ack == null)? 0 :this.return_to_normal_ack.hashCode())); return result; } @@ -44,7 +86,7 @@ public boolean equals(Object other) { return false; } AlarmAlarmsetEvents rhs = ((AlarmAlarmsetEvents) other); - return ((this.present_value == rhs.present_value)||((this.present_value!= null)&&this.present_value.equals(rhs.present_value))); + return ((((((this.return_to_normal_time == rhs.return_to_normal_time)||((this.return_to_normal_time!= null)&&this.return_to_normal_time.equals(rhs.return_to_normal_time)))&&((this.active == rhs.active)||((this.active!= null)&&this.active.equals(rhs.active))))&&((this.activate_time == rhs.activate_time)||((this.activate_time!= null)&&this.activate_time.equals(rhs.activate_time))))&&((this.activate_ack == rhs.activate_ack)||((this.activate_ack!= null)&&this.activate_ack.equals(rhs.activate_ack))))&&((this.return_to_normal_ack == rhs.return_to_normal_ack)||((this.return_to_normal_ack!= null)&&this.return_to_normal_ack.equals(rhs.return_to_normal_ack)))); } } diff --git a/gencode/java/udmi/schema/AlarmAlarmsetModel.java b/gencode/java/udmi/schema/AlarmAlarmsetModel.java index 51a80d1fba..d680729568 100644 --- a/gencode/java/udmi/schema/AlarmAlarmsetModel.java +++ b/gencode/java/udmi/schema/AlarmAlarmsetModel.java @@ -1,164 +1,100 @@ package udmi.schema; -import java.util.HashMap; import java.util.Map; -import java.util.Set; -import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyDescription; import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.databind.annotation.JsonDeserialize; /** * Alarm Alarmset Model *

* Information about a specific alarm name of the device. - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ - "units", - "type", "description", - "writable", - "baseline_value", - "baseline_tolerance", - "baseline_state", - "range_min", - "range_max", - "unchanged_limit_sec", - "cov_increment", + "category", + "severity", + "requires_ack", + "return_to_normal_event", + "return_requires_ack", "ref", - "adjunct", - "tags", "structure" }) public class AlarmAlarmsetModel { - /** - * Expected unit configuration for the alarm - * - */ - @JsonProperty("units") - @JsonPropertyDescription("Expected unit configuration for the alarm") - public java.lang.String units; - /** - * Expected data type for the alarm - * - */ - @JsonProperty("type") - @JsonPropertyDescription("Expected data type for the alarm") - public AlarmAlarmsetModel.Type type; /** * Detailed description of this alarm - * + * */ @JsonProperty("description") @JsonPropertyDescription("Detailed description of this alarm") public java.lang.String description; /** - * Indicates if this alarm is writable (else read-only) - * - */ - @JsonProperty("writable") - @JsonPropertyDescription("Indicates if this alarm is writable (else read-only)") - public Boolean writable; - /** - * Represents the expected baseline value of the alarm - * + * Category that this alarm is classified as + * */ - @JsonProperty("baseline_value") - @JsonPropertyDescription("Represents the expected baseline value of the alarm") - public Object baseline_value; + @JsonProperty("category") + @JsonPropertyDescription("Category that this alarm is classified as") + public java.lang.String category; /** - * Maximum deviation from `baseline_value` - * + * Severity of the alarm + * */ - @JsonProperty("baseline_tolerance") - @JsonPropertyDescription("Maximum deviation from `baseline_value`") - public Double baseline_tolerance; + @JsonProperty("severity") + @JsonPropertyDescription("Severity of the alarm") + public java.lang.String severity; /** - * Expected state when `baseline_value` is set as the `set_value` for this alarm the config message - * + * Indicates whether or not alarm activation requries acknowledgement. + * */ - @JsonProperty("baseline_state") - @JsonPropertyDescription("Expected state when `baseline_value` is set as the `set_value` for this alarm the config message") - public AlarmAlarmsetModel.Baseline_state baseline_state; + @JsonProperty("requires_ack") + @JsonPropertyDescription("Indicates whether or not alarm activation requries acknowledgement.") + public Boolean requires_ack; /** - * Represents the lower bound of the error threshold for a alarm - * + * Indicates whether or not the alarm sends return-to-normal events. + * */ - @JsonProperty("range_min") - @JsonPropertyDescription("Represents the lower bound of the error threshold for a alarm") - public Double range_min; + @JsonProperty("return_to_normal_event") + @JsonPropertyDescription("Indicates whether or not the alarm sends return-to-normal events.") + public Boolean return_to_normal_event; /** - * Represents the upper bound of the error threshold for a alarm - * + * Indicates whether or not returning to normal requries acknowledgement. + * */ - @JsonProperty("range_max") - @JsonPropertyDescription("Represents the upper bound of the error threshold for a alarm") - public Double range_max; + @JsonProperty("return_requires_ack") + @JsonPropertyDescription("Indicates whether or not returning to normal requries acknowledgement.") + public Boolean return_requires_ack; /** - * Represents the limit in seconds that a alarm can be unchanged for - * - */ - @JsonProperty("unchanged_limit_sec") - @JsonPropertyDescription("Represents the limit in seconds that a alarm can be unchanged for") - public Integer unchanged_limit_sec; - /** - * Triggering threshold for partial cov update publishing - * - */ - @JsonProperty("cov_increment") - @JsonPropertyDescription("Triggering threshold for partial cov update publishing") - public Double cov_increment; - /** - * Mapping for the alarm to an internal resource (e.g. BACnet object reference) - * + * Mapping for the alarm to its internal counterpart + * */ @JsonProperty("ref") - @JsonPropertyDescription("Mapping for the alarm to an internal resource (e.g. BACnet object reference)") + @JsonPropertyDescription("Mapping for the alarm to its internal counterpart") public java.lang.String ref; - @JsonProperty("adjunct") - public Map adjunct; - /** - * Tags assosciated with the alarm - * - */ - @JsonProperty("tags") - @JsonDeserialize(as = java.util.LinkedHashSet.class) - @JsonPropertyDescription("Tags assosciated with the alarm") - public Set tags; /** - * Collection of family alarm information - * + * Collection of alarm information + * */ @JsonProperty("structure") - @JsonPropertyDescription("Collection of family alarm information") - public Map structure; + @JsonPropertyDescription("Collection of alarm information") + public Map structure; @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.baseline_state == null)? 0 :this.baseline_state.hashCode())); - result = ((result* 31)+((this.range_min == null)? 0 :this.range_min.hashCode())); + result = ((result* 31)+((this.severity == null)? 0 :this.severity.hashCode())); + result = ((result* 31)+((this.return_requires_ack == null)? 0 :this.return_requires_ack.hashCode())); + result = ((result* 31)+((this.ref == null)? 0 :this.ref.hashCode())); + result = ((result* 31)+((this.return_to_normal_event == null)? 0 :this.return_to_normal_event.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.baseline_tolerance == null)? 0 :this.baseline_tolerance.hashCode())); + result = ((result* 31)+((this.category == null)? 0 :this.category.hashCode())); + result = ((result* 31)+((this.requires_ack == null)? 0 :this.requires_ack.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.tags == null)? 0 :this.tags.hashCode())); - result = ((result* 31)+((this.ref == null)? 0 :this.ref.hashCode())); - result = ((result* 31)+((this.baseline_value == null)? 0 :this.baseline_value.hashCode())); - result = ((result* 31)+((this.range_max == null)? 0 :this.range_max.hashCode())); - result = ((result* 31)+((this.unchanged_limit_sec == null)? 0 :this.unchanged_limit_sec.hashCode())); - result = ((result* 31)+((this.adjunct == null)? 0 :this.adjunct.hashCode())); - result = ((result* 31)+((this.cov_increment == null)? 0 :this.cov_increment.hashCode())); return result; } @@ -171,99 +107,7 @@ public boolean equals(Object other) { return false; } AlarmAlarmsetModel rhs = ((AlarmAlarmsetModel) other); - return ((((((((((((((((this.baseline_state == rhs.baseline_state)||((this.baseline_state!= null)&&this.baseline_state.equals(rhs.baseline_state)))&&((this.range_min == rhs.range_min)||((this.range_min!= null)&&this.range_min.equals(rhs.range_min))))&&((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.baseline_tolerance == rhs.baseline_tolerance)||((this.baseline_tolerance!= null)&&this.baseline_tolerance.equals(rhs.baseline_tolerance))))&&((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.tags == rhs.tags)||((this.tags!= null)&&this.tags.equals(rhs.tags))))&&((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref))))&&((this.baseline_value == rhs.baseline_value)||((this.baseline_value!= null)&&this.baseline_value.equals(rhs.baseline_value))))&&((this.range_max == rhs.range_max)||((this.range_max!= null)&&this.range_max.equals(rhs.range_max))))&&((this.unchanged_limit_sec == rhs.unchanged_limit_sec)||((this.unchanged_limit_sec!= null)&&this.unchanged_limit_sec.equals(rhs.unchanged_limit_sec))))&&((this.adjunct == rhs.adjunct)||((this.adjunct!= null)&&this.adjunct.equals(rhs.adjunct))))&&((this.cov_increment == rhs.cov_increment)||((this.cov_increment!= null)&&this.cov_increment.equals(rhs.cov_increment)))); - } - - - /** - * Expected state when `baseline_value` is set as the `set_value` for this alarm the config message - * - */ - public enum Baseline_state { - - APPLIED("applied"), - UPDATING("updating"), - OVERRIDDEN("overridden"), - INVALID("invalid"), - FAILURE("failure"); - private final java.lang.String value; - private final static Map CONSTANTS = new HashMap(); - - static { - for (AlarmAlarmsetModel.Baseline_state c: values()) { - CONSTANTS.put(c.value, c); - } - } - - Baseline_state(java.lang.String value) { - this.value = value; - } - - @Override - public java.lang.String toString() { - return this.value; - } - - @JsonValue - public java.lang.String value() { - return this.value; - } - - @JsonCreator - public static AlarmAlarmsetModel.Baseline_state fromValue(java.lang.String value) { - AlarmAlarmsetModel.Baseline_state constant = CONSTANTS.get(value); - if (constant == null) { - throw new IllegalArgumentException(value); - } else { - return constant; - } - } - - } - - - /** - * Expected data type for the alarm - * - */ - public enum Type { - - STRING("string"), - BOOLEAN("boolean"), - NUMBER("number"); - private final java.lang.String value; - private final static Map CONSTANTS = new HashMap(); - - static { - for (AlarmAlarmsetModel.Type c: values()) { - CONSTANTS.put(c.value, c); - } - } - - Type(java.lang.String value) { - this.value = value; - } - - @Override - public java.lang.String toString() { - return this.value; - } - - @JsonValue - public java.lang.String value() { - return this.value; - } - - @JsonCreator - public static AlarmAlarmsetModel.Type fromValue(java.lang.String value) { - AlarmAlarmsetModel.Type constant = CONSTANTS.get(value); - if (constant == null) { - throw new IllegalArgumentException(value); - } else { - return constant; - } - } - + return (((((((((this.severity == rhs.severity)||((this.severity!= null)&&this.severity.equals(rhs.severity)))&&((this.return_requires_ack == rhs.return_requires_ack)||((this.return_requires_ack!= null)&&this.return_requires_ack.equals(rhs.return_requires_ack))))&&((this.ref == rhs.ref)||((this.ref!= null)&&this.ref.equals(rhs.ref))))&&((this.return_to_normal_event == rhs.return_to_normal_event)||((this.return_to_normal_event!= null)&&this.return_to_normal_event.equals(rhs.return_to_normal_event))))&&((this.description == rhs.description)||((this.description!= null)&&this.description.equals(rhs.description))))&&((this.category == rhs.category)||((this.category!= null)&&this.category.equals(rhs.category))))&&((this.requires_ack == rhs.requires_ack)||((this.requires_ack!= null)&&this.requires_ack.equals(rhs.requires_ack))))&&((this.structure == rhs.structure)||((this.structure!= null)&&this.structure.equals(rhs.structure)))); } } diff --git a/gencode/java/udmi/schema/AlarmAlarmsetState.java b/gencode/java/udmi/schema/AlarmAlarmsetState.java index ad366079dc..6ccc060e30 100644 --- a/gencode/java/udmi/schema/AlarmAlarmsetState.java +++ b/gencode/java/udmi/schema/AlarmAlarmsetState.java @@ -1,49 +1,28 @@ package udmi.schema; -import java.util.HashMap; -import java.util.Map; -import com.fasterxml.jackson.annotation.JsonCreator; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.annotation.JsonPropertyDescription; import com.fasterxml.jackson.annotation.JsonPropertyOrder; -import com.fasterxml.jackson.annotation.JsonValue; /** * Alarm Alarmset State *

* Object representation for for a single alarm - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ - "units", - "value_state", "status" }) public class AlarmAlarmsetState { - /** - * If specified, indicates a programmed alarm unit. If empty, means unspecified or matches configured alarm. - * - */ - @JsonProperty("units") - @JsonPropertyDescription("If specified, indicates a programmed alarm unit. If empty, means unspecified or matches configured alarm.") - public String units; - /** - * State of the individual alarm - * - */ - @JsonProperty("value_state") - @JsonPropertyDescription("State of the individual alarm") - public AlarmAlarmsetState.Value_state value_state; /** * Entry *

- * - * + * + * */ @JsonProperty("status") public Entry status; @@ -51,8 +30,6 @@ public class AlarmAlarmsetState { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.value_state == null)? 0 :this.value_state.hashCode())); - result = ((result* 31)+((this.units == null)? 0 :this.units.hashCode())); result = ((result* 31)+((this.status == null)? 0 :this.status.hashCode())); return result; } @@ -66,55 +43,7 @@ public boolean equals(Object other) { return false; } AlarmAlarmsetState rhs = ((AlarmAlarmsetState) other); - return ((((this.value_state == rhs.value_state)||((this.value_state!= null)&&this.value_state.equals(rhs.value_state)))&&((this.units == rhs.units)||((this.units!= null)&&this.units.equals(rhs.units))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status)))); - } - - - /** - * State of the individual alarm - * - */ - public enum Value_state { - - INITIALIZING("initializing"), - APPLIED("applied"), - UPDATING("updating"), - OVERRIDDEN("overridden"), - INVALID("invalid"), - FAILURE("failure"); - private final String value; - private final static Map CONSTANTS = new HashMap(); - - static { - for (AlarmAlarmsetState.Value_state c: values()) { - CONSTANTS.put(c.value, c); - } - } - - Value_state(String value) { - this.value = value; - } - - @Override - public String toString() { - return this.value; - } - - @JsonValue - public String value() { - return this.value; - } - - @JsonCreator - public static AlarmAlarmsetState.Value_state fromValue(String value) { - AlarmAlarmsetState.Value_state constant = CONSTANTS.get(value); - if (constant == null) { - throw new IllegalArgumentException(value); - } else { - return constant; - } - } - + return ((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status))); } } diff --git a/gencode/java/udmi/schema/AlarmRefDiscovery.java b/gencode/java/udmi/schema/AlarmRefDiscovery.java new file mode 100644 index 0000000000..1a86dba0a2 --- /dev/null +++ b/gencode/java/udmi/schema/AlarmRefDiscovery.java @@ -0,0 +1,112 @@ + +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; + + +/** + * Alarm Ref Discovery + *

+ * Object representation for for a single alarm reference discovery + * + */ +@JsonInclude(JsonInclude.Include.NON_NULL) +@JsonPropertyOrder({ + "alarm", + "name", + "description", + "category", + "severity", + "requires_ack", + "return_to_normal_event", + "return_requires_ack" +}) +public class AlarmRefDiscovery { + + /** + * Alarm descriptor for this alarm + * + */ + @JsonProperty("alarm") + @JsonPropertyDescription("Alarm descriptor for this alarm") + public String alarm; + /** + * Friendly name for the reference, if known + * + */ + @JsonProperty("name") + @JsonPropertyDescription("Friendly name for the reference, if known") + public String name; + /** + * Detailed description of this alarm + * + */ + @JsonProperty("description") + @JsonPropertyDescription("Detailed description of this alarm") + public String description; + /** + * Category that this alarm is classified as + * + */ + @JsonProperty("category") + @JsonPropertyDescription("Category that this alarm is classified as") + public String category; + /** + * Severity of the alarm + * + */ + @JsonProperty("severity") + @JsonPropertyDescription("Severity of the alarm") + public String severity; + /** + * Indicates whether or not alarm activation requries acknowledgement. + * + */ + @JsonProperty("requires_ack") + @JsonPropertyDescription("Indicates whether or not alarm activation requries acknowledgement.") + public Boolean requires_ack; + /** + * Indicates whether or not the alarm sends return-to-normal events. + * + */ + @JsonProperty("return_to_normal_event") + @JsonPropertyDescription("Indicates whether or not the alarm sends return-to-normal events.") + public Boolean return_to_normal_event; + /** + * Indicates whether or not returning to normal requries acknowledgement. + * + */ + @JsonProperty("return_requires_ack") + @JsonPropertyDescription("Indicates whether or not returning to normal requries acknowledgement.") + public Boolean return_requires_ack; + + @Override + public int hashCode() { + int result = 1; + result = ((result* 31)+((this.severity == null)? 0 :this.severity.hashCode())); + result = ((result* 31)+((this.return_requires_ack == null)? 0 :this.return_requires_ack.hashCode())); + result = ((result* 31)+((this.return_to_normal_event == null)? 0 :this.return_to_normal_event.hashCode())); + result = ((result* 31)+((this.alarm == null)? 0 :this.alarm.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.category == null)? 0 :this.category.hashCode())); + result = ((result* 31)+((this.requires_ack == null)? 0 :this.requires_ack.hashCode())); + return result; + } + + @Override + public boolean equals(Object other) { + if (other == this) { + return true; + } + if ((other instanceof AlarmRefDiscovery) == false) { + return false; + } + AlarmRefDiscovery rhs = ((AlarmRefDiscovery) other); + return (((((((((this.severity == rhs.severity)||((this.severity!= null)&&this.severity.equals(rhs.severity)))&&((this.return_requires_ack == rhs.return_requires_ack)||((this.return_requires_ack!= null)&&this.return_requires_ack.equals(rhs.return_requires_ack))))&&((this.return_to_normal_event == rhs.return_to_normal_event)||((this.return_to_normal_event!= null)&&this.return_to_normal_event.equals(rhs.return_to_normal_event))))&&((this.alarm == rhs.alarm)||((this.alarm!= null)&&this.alarm.equals(rhs.alarm))))&&((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.category == rhs.category)||((this.category!= null)&&this.category.equals(rhs.category))))&&((this.requires_ack == rhs.requires_ack)||((this.requires_ack!= null)&&this.requires_ack.equals(rhs.requires_ack)))); + } + +} diff --git a/gencode/java/udmi/schema/AlarmsetConfig.java b/gencode/java/udmi/schema/AlarmsetConfig.java index a20c237aef..571ea22b58 100644 --- a/gencode/java/udmi/schema/AlarmsetConfig.java +++ b/gencode/java/udmi/schema/AlarmsetConfig.java @@ -13,80 +13,44 @@ * Alarmset Config *

* [Alarmset Config Documentation](../docs/messages/alarmset.md#config) - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ "timestamp", "version", - "state_etag", - "set_value_expiry", - "sample_limit_sec", - "sample_rate_sec", "alarms" }) public class AlarmsetConfig { /** * RFC 3339 UTC timestamp the configuration was generated - * + * */ @JsonProperty("timestamp") @JsonPropertyDescription("RFC 3339 UTC timestamp the configuration was generated") public Date timestamp; /** * Version of the UDMI schema - * + * */ @JsonProperty("version") @JsonPropertyDescription("Version of the UDMI schema") public java.lang.String version; /** - * The `state_etag` of the last _state_ message sent by the device. [Writeback documentation](../docs/specs/sequences/writeback.md) - * - */ - @JsonProperty("state_etag") - @JsonPropertyDescription("The `state_etag` of the last _state_ message sent by the device. [Writeback documentation](../docs/specs/sequences/writeback.md)") - public java.lang.String state_etag; - /** - * An expiry for the the device to revert to baseline (no set value). [Writeback documentation](../docs/specs/sequences/writeback.md) - * - */ - @JsonProperty("set_value_expiry") - @JsonPropertyDescription("An expiry for the the device to revert to baseline (no set value). [Writeback documentation](../docs/specs/sequences/writeback.md)") - public Date set_value_expiry; - /** - * Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update. - * - */ - @JsonProperty("sample_limit_sec") - @JsonPropertyDescription("Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.") - public Integer sample_limit_sec; - /** - * Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 300. - * - */ - @JsonProperty("sample_rate_sec") - @JsonPropertyDescription("Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 300.") - public Integer sample_rate_sec = 300; - /** - * The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device (in both `telemetry` and `state` messages). [Alarmset doumentation](../docs/messages/alarmset.md) - * + * The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device. [Alarmset doumentation](../docs/messages/alarmset.md) + * */ @JsonProperty("alarms") - @JsonPropertyDescription("The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device (in both `telemetry` and `state` messages). [Alarmset doumentation](../docs/messages/alarmset.md)") + @JsonPropertyDescription("The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device. [Alarmset doumentation](../docs/messages/alarmset.md)") public HashMap alarms; @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.sample_rate_sec == null)? 0 :this.sample_rate_sec.hashCode())); - result = ((result* 31)+((this.alarms == null)? 0 :this.alarms.hashCode())); - result = ((result* 31)+((this.state_etag == null)? 0 :this.state_etag.hashCode())); - result = ((result* 31)+((this.set_value_expiry == null)? 0 :this.set_value_expiry.hashCode())); result = ((result* 31)+((this.version == null)? 0 :this.version.hashCode())); - result = ((result* 31)+((this.sample_limit_sec == null)? 0 :this.sample_limit_sec.hashCode())); result = ((result* 31)+((this.timestamp == null)? 0 :this.timestamp.hashCode())); + result = ((result* 31)+((this.alarms == null)? 0 :this.alarms.hashCode())); return result; } @@ -99,7 +63,7 @@ public boolean equals(Object other) { return false; } AlarmsetConfig rhs = ((AlarmsetConfig) other); - return ((((((((this.sample_rate_sec == rhs.sample_rate_sec)||((this.sample_rate_sec!= null)&&this.sample_rate_sec.equals(rhs.sample_rate_sec)))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms))))&&((this.state_etag == rhs.state_etag)||((this.state_etag!= null)&&this.state_etag.equals(rhs.state_etag))))&&((this.set_value_expiry == rhs.set_value_expiry)||((this.set_value_expiry!= null)&&this.set_value_expiry.equals(rhs.set_value_expiry))))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.sample_limit_sec == rhs.sample_limit_sec)||((this.sample_limit_sec!= null)&&this.sample_limit_sec.equals(rhs.sample_limit_sec))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp)))); + return ((((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version)))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))); } } diff --git a/gencode/java/udmi/schema/AlarmsetEvents.java b/gencode/java/udmi/schema/AlarmsetEvents.java index 57be58d30e..29fee2ff4c 100644 --- a/gencode/java/udmi/schema/AlarmsetEvents.java +++ b/gencode/java/udmi/schema/AlarmsetEvents.java @@ -12,53 +12,45 @@ /** * Alarmset Events *

- * A set of alarms reporting telemetry data. [Alarmset Events Documentation](../docs/messages/alarmset.md#telemetry) - * + * A set of alarm events. + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ "timestamp", "version", "upgraded_from", - "partial_update", "alarms" }) public class AlarmsetEvents { /** - * RFC 3339 UTC timestamp the telemetry event was generated + * RFC 3339 UTC timestamp the alarm event was generated * (Required) - * + * */ @JsonProperty("timestamp") - @JsonPropertyDescription("RFC 3339 UTC timestamp the telemetry event was generated") + @JsonPropertyDescription("RFC 3339 UTC timestamp the alarm event was generated") public Date timestamp; /** * Version of the UDMI schema * (Required) - * + * */ @JsonProperty("version") @JsonPropertyDescription("Version of the UDMI schema") public java.lang.String version; /** * Original version of schema pre-upgrade - * + * */ @JsonProperty("upgraded_from") @JsonPropertyDescription("Original version of schema pre-upgrade") public java.lang.String upgraded_from; - /** - * Indicates if this is a partial update (only some alarms may be included) - * - */ - @JsonProperty("partial_update") - @JsonPropertyDescription("Indicates if this is a partial update (only some alarms may be included)") - public Boolean partial_update; /** * Collection of alarm names, defining the representative alarm set for this device. * (Required) - * + * */ @JsonProperty("alarms") @JsonPropertyDescription("Collection of alarm names, defining the representative alarm set for this device.") @@ -67,7 +59,6 @@ public class AlarmsetEvents { @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.partial_update == null)? 0 :this.partial_update.hashCode())); result = ((result* 31)+((this.upgraded_from == null)? 0 :this.upgraded_from.hashCode())); result = ((result* 31)+((this.version == null)? 0 :this.version.hashCode())); result = ((result* 31)+((this.timestamp == null)? 0 :this.timestamp.hashCode())); @@ -84,7 +75,7 @@ public boolean equals(Object other) { return false; } AlarmsetEvents rhs = ((AlarmsetEvents) other); - return ((((((this.partial_update == rhs.partial_update)||((this.partial_update!= null)&&this.partial_update.equals(rhs.partial_update)))&&((this.upgraded_from == rhs.upgraded_from)||((this.upgraded_from!= null)&&this.upgraded_from.equals(rhs.upgraded_from))))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))); + return (((((this.upgraded_from == rhs.upgraded_from)||((this.upgraded_from!= null)&&this.upgraded_from.equals(rhs.upgraded_from)))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))); } } diff --git a/gencode/java/udmi/schema/AlarmsetModel.java b/gencode/java/udmi/schema/AlarmsetModel.java index 8022508226..2fcdd86e9b 100644 --- a/gencode/java/udmi/schema/AlarmsetModel.java +++ b/gencode/java/udmi/schema/AlarmsetModel.java @@ -12,53 +12,31 @@ * Alarmset Model *

* Alarmset 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 alarms that a device holds - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ "alarms", - "exclude_units_from_config", - "exclude_alarms_from_config", - "sample_limit_sec", - "sample_rate_sec" + "exclude_alarms_from_config" }) public class AlarmsetModel { /** * Information about a specific alarm name of the device. * (Required) - * + * */ @JsonProperty("alarms") @JsonPropertyDescription("Information about a specific alarm name of the device.") public HashMap alarms; - @JsonProperty("exclude_units_from_config") - public Boolean exclude_units_from_config; @JsonProperty("exclude_alarms_from_config") public Boolean exclude_alarms_from_config; - /** - * Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update. - * - */ - @JsonProperty("sample_limit_sec") - @JsonPropertyDescription("Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.") - public Integer sample_limit_sec; - /** - * 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. - * - */ - @JsonProperty("sample_rate_sec") - @JsonPropertyDescription("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.") - public Integer sample_rate_sec; @Override public int hashCode() { int result = 1; - result = ((result* 31)+((this.sample_rate_sec == null)? 0 :this.sample_rate_sec.hashCode())); - result = ((result* 31)+((this.exclude_units_from_config == null)? 0 :this.exclude_units_from_config.hashCode())); - result = ((result* 31)+((this.exclude_alarms_from_config == null)? 0 :this.exclude_alarms_from_config.hashCode())); - result = ((result* 31)+((this.sample_limit_sec == null)? 0 :this.sample_limit_sec.hashCode())); result = ((result* 31)+((this.alarms == null)? 0 :this.alarms.hashCode())); + result = ((result* 31)+((this.exclude_alarms_from_config == null)? 0 :this.exclude_alarms_from_config.hashCode())); return result; } @@ -71,7 +49,7 @@ public boolean equals(Object other) { return false; } AlarmsetModel rhs = ((AlarmsetModel) other); - return ((((((this.sample_rate_sec == rhs.sample_rate_sec)||((this.sample_rate_sec!= null)&&this.sample_rate_sec.equals(rhs.sample_rate_sec)))&&((this.exclude_units_from_config == rhs.exclude_units_from_config)||((this.exclude_units_from_config!= null)&&this.exclude_units_from_config.equals(rhs.exclude_units_from_config))))&&((this.exclude_alarms_from_config == rhs.exclude_alarms_from_config)||((this.exclude_alarms_from_config!= null)&&this.exclude_alarms_from_config.equals(rhs.exclude_alarms_from_config))))&&((this.sample_limit_sec == rhs.sample_limit_sec)||((this.sample_limit_sec!= null)&&this.sample_limit_sec.equals(rhs.sample_limit_sec))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))); + return (((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))&&((this.exclude_alarms_from_config == rhs.exclude_alarms_from_config)||((this.exclude_alarms_from_config!= null)&&this.exclude_alarms_from_config.equals(rhs.exclude_alarms_from_config)))); } } diff --git a/gencode/java/udmi/schema/AlarmsetState.java b/gencode/java/udmi/schema/AlarmsetState.java index 4a473cde1e..e4975ca675 100644 --- a/gencode/java/udmi/schema/AlarmsetState.java +++ b/gencode/java/udmi/schema/AlarmsetState.java @@ -13,7 +13,7 @@ * Alarmset State *

* A set of alarms reporting telemetry data. - * + * */ @JsonInclude(JsonInclude.Include.NON_NULL) @JsonPropertyOrder({ @@ -28,21 +28,21 @@ public class AlarmsetState { /** * Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated - * + * */ @JsonProperty("timestamp") @JsonPropertyDescription("Not included in messages published by devices. Part of message subblocks within cloud pipeline. RFC 3339 Timestamp the payload was generated") public Date timestamp; /** * Version of the UDMI schema, not included in messages published by devices - * + * */ @JsonProperty("version") @JsonPropertyDescription("Version of the UDMI schema, not included in messages published by devices") public java.lang.String version; /** * 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](../docs/specs/sequences/writeback.md) - * + * */ @JsonProperty("state_etag") @JsonPropertyDescription("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](../docs/specs/sequences/writeback.md)") @@ -50,22 +50,22 @@ public class AlarmsetState { /** * Entry *

- * - * + * + * */ @JsonProperty("status") public Entry status; /** * Collection of alarm names, defining the representative alarm set for this device. * (Required) - * + * */ @JsonProperty("alarms") @JsonPropertyDescription("Collection of alarm names, defining the representative alarm set for this device.") public HashMap alarms; /** * Original version of schema pre-upgrade - * + * */ @JsonProperty("upgraded_from") @JsonPropertyDescription("Original version of schema pre-upgrade") diff --git a/gencode/java/udmi/schema/Category.java b/gencode/java/udmi/schema/Category.java index dd0c5c81ba..83c98c9f5e 100644 --- a/gencode/java/udmi/schema/Category.java +++ b/gencode/java/udmi/schema/Category.java @@ -105,6 +105,12 @@ public class Category { public static final int POINTSET_POINT_INVALID_VALUE = ERROR.value(); static { LEVEL.put(POINTSET_POINT_INVALID, ERROR); } + // A `config` parameter for the alarm is invalid in some way + public static final String ALARMSET_ALARM_INVALID = "alarmset.alarm.invalid"; + public static final Level ALARMSET_ALARM_INVALID_LEVEL = ERROR; + public static final int ALARMSET_ALARM_INVALID_VALUE = ERROR.value(); + static { LEVEL.put(ALARMSET_ALARM_INVALID, ERROR); } + // Aspects of a specific network public static final String LOCALNET_NETWORK = "localnet.network"; public static final Level LOCALNET_NETWORK_LEVEL = INFO; diff --git a/gencode/java/udmi/schema/Config.java b/gencode/java/udmi/schema/Config.java index 194870a0bc..91056ab0a3 100644 --- a/gencode/java/udmi/schema/Config.java +++ b/gencode/java/udmi/schema/Config.java @@ -100,7 +100,7 @@ public class Config { * Alarmset Config *

* [Alarmset Config Documentation](../docs/messages/alarmset.md#config) - * + * */ @JsonProperty("alarmset") @JsonPropertyDescription("[Alarmset Config Documentation](../docs/messages/alarmset.md#config)") diff --git a/gencode/java/udmi/schema/DiscoveryConfig.java b/gencode/java/udmi/schema/DiscoveryConfig.java index 91ed927a43..31cb994250 100644 --- a/gencode/java/udmi/schema/DiscoveryConfig.java +++ b/gencode/java/udmi/schema/DiscoveryConfig.java @@ -19,7 +19,8 @@ @JsonPropertyOrder({ "generation", "enumerations", - "families" + "families", + "alarms" }) public class DiscoveryConfig { @@ -44,13 +45,21 @@ public class DiscoveryConfig { @JsonProperty("families") @JsonPropertyDescription("Address family configs for discovery scans.") public Map families; + /** + * Indicates whether or not to discover alarms. + * + */ + @JsonProperty("alarms") + @JsonPropertyDescription("Indicates whether or not to discover alarms.") + public Boolean alarms; @Override public int hashCode() { int result = 1; result = ((result* 31)+((this.generation == null)? 0 :this.generation.hashCode())); - result = ((result* 31)+((this.families == null)? 0 :this.families.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.alarms == null)? 0 :this.alarms.hashCode())); return result; } @@ -63,7 +72,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.families == rhs.families)||((this.families!= null)&&this.families.equals(rhs.families))))&&((this.enumerations == rhs.enumerations)||((this.enumerations!= null)&&this.enumerations.equals(rhs.enumerations)))); + 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))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms)))); } } diff --git a/gencode/java/udmi/schema/DiscoveryEvents.java b/gencode/java/udmi/schema/DiscoveryEvents.java index 05c330bc71..6aaa690dba 100644 --- a/gencode/java/udmi/schema/DiscoveryEvents.java +++ b/gencode/java/udmi/schema/DiscoveryEvents.java @@ -30,6 +30,8 @@ "devices", "points", "refs", + "alarms", + "alarm_refs", "features", "cloud_model", "system" @@ -123,6 +125,20 @@ public class DiscoveryEvents { @JsonProperty("refs") @JsonPropertyDescription("Collection of point references") public Map refs; + /** + * Information about a specific alarm name of the device. + * + */ + @JsonProperty("alarms") + @JsonPropertyDescription("Information about a specific alarm name of the device.") + public Map alarms; + /** + * Collection of alarm references + * + */ + @JsonProperty("alarm_refs") + @JsonPropertyDescription("Collection of alarm references") + public Map alarm_refs; /** * Discovery of features supported by this device. * @@ -153,6 +169,7 @@ public int hashCode() { int result = 1; result = ((result* 31)+((this.generation == null)? 0 :this.generation.hashCode())); result = ((result* 31)+((this.devices == null)? 0 :this.devices.hashCode())); + result = ((result* 31)+((this.alarms == null)? 0 :this.alarms.hashCode())); result = ((result* 31)+((this.registries == null)? 0 :this.registries.hashCode())); result = ((result* 31)+((this.families == null)? 0 :this.families.hashCode())); result = ((result* 31)+((this.version == null)? 0 :this.version.hashCode())); @@ -162,6 +179,7 @@ public int hashCode() { result = ((result* 31)+((this.system == null)? 0 :this.system.hashCode())); result = ((result* 31)+((this.event_no == null)? 0 :this.event_no.hashCode())); result = ((result* 31)+((this.refs == null)? 0 :this.refs.hashCode())); + result = ((result* 31)+((this.alarm_refs == null)? 0 :this.alarm_refs.hashCode())); result = ((result* 31)+((this.family == null)? 0 :this.family.hashCode())); result = ((result* 31)+((this.addr == null)? 0 :this.addr.hashCode())); result = ((result* 31)+((this.cloud_model == null)? 0 :this.cloud_model.hashCode())); @@ -179,7 +197,7 @@ public boolean equals(Object other) { return false; } DiscoveryEvents rhs = ((DiscoveryEvents) other); - return (((((((((((((((((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation)))&&((this.devices == rhs.devices)||((this.devices!= null)&&this.devices.equals(rhs.devices))))&&((this.registries == rhs.registries)||((this.registries!= null)&&this.registries.equals(rhs.registries))))&&((this.families == rhs.families)||((this.families!= null)&&this.families.equals(rhs.families))))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.network == rhs.network)||((this.network!= null)&&this.network.equals(rhs.network))))&&((this.points == rhs.points)||((this.points!= null)&&this.points.equals(rhs.points))))&&((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.event_no == rhs.event_no)||((this.event_no!= null)&&this.event_no.equals(rhs.event_no))))&&((this.refs == rhs.refs)||((this.refs!= null)&&this.refs.equals(rhs.refs))))&&((this.family == rhs.family)||((this.family!= null)&&this.family.equals(rhs.family))))&&((this.addr == rhs.addr)||((this.addr!= null)&&this.addr.equals(rhs.addr))))&&((this.cloud_model == rhs.cloud_model)||((this.cloud_model!= null)&&this.cloud_model.equals(rhs.cloud_model))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status)))); + return (((((((((((((((((((this.generation == rhs.generation)||((this.generation!= null)&&this.generation.equals(rhs.generation)))&&((this.devices == rhs.devices)||((this.devices!= null)&&this.devices.equals(rhs.devices))))&&((this.alarms == rhs.alarms)||((this.alarms!= null)&&this.alarms.equals(rhs.alarms))))&&((this.registries == rhs.registries)||((this.registries!= null)&&this.registries.equals(rhs.registries))))&&((this.families == rhs.families)||((this.families!= null)&&this.families.equals(rhs.families))))&&((this.version == rhs.version)||((this.version!= null)&&this.version.equals(rhs.version))))&&((this.network == rhs.network)||((this.network!= null)&&this.network.equals(rhs.network))))&&((this.points == rhs.points)||((this.points!= null)&&this.points.equals(rhs.points))))&&((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.event_no == rhs.event_no)||((this.event_no!= null)&&this.event_no.equals(rhs.event_no))))&&((this.refs == rhs.refs)||((this.refs!= null)&&this.refs.equals(rhs.refs))))&&((this.alarm_refs == rhs.alarm_refs)||((this.alarm_refs!= null)&&this.alarm_refs.equals(rhs.alarm_refs))))&&((this.family == rhs.family)||((this.family!= null)&&this.family.equals(rhs.family))))&&((this.addr == rhs.addr)||((this.addr!= null)&&this.addr.equals(rhs.addr))))&&((this.cloud_model == rhs.cloud_model)||((this.cloud_model!= null)&&this.cloud_model.equals(rhs.cloud_model))))&&((this.timestamp == rhs.timestamp)||((this.timestamp!= null)&&this.timestamp.equals(rhs.timestamp))))&&((this.status == rhs.status)||((this.status!= null)&&this.status.equals(rhs.status)))); } } diff --git a/gencode/java/udmi/schema/FamilyLocalnetModel.java b/gencode/java/udmi/schema/FamilyLocalnetModel.java index 4a1a2147eb..604bd1b2e8 100644 --- a/gencode/java/udmi/schema/FamilyLocalnetModel.java +++ b/gencode/java/udmi/schema/FamilyLocalnetModel.java @@ -65,7 +65,7 @@ public class FamilyLocalnetModel { public java.lang.String family; /** * The network within the gateway device to use for this network - * + * */ @JsonProperty("network_id") @JsonPropertyDescription("The network within the gateway device to use for this network") diff --git a/gencode/java/udmi/schema/LocalnetConfig.java b/gencode/java/udmi/schema/LocalnetConfig.java index 985a083b7c..0f28b39948 100644 --- a/gencode/java/udmi/schema/LocalnetConfig.java +++ b/gencode/java/udmi/schema/LocalnetConfig.java @@ -30,7 +30,7 @@ public class LocalnetConfig { public HashMap families; /** * Network address family config for reporting. - * + * */ @JsonProperty("networks") @JsonPropertyDescription("Network address family config for reporting.") diff --git a/gencode/java/udmi/schema/Metadata.java b/gencode/java/udmi/schema/Metadata.java index 4134f08a22..3d32abca96 100644 --- a/gencode/java/udmi/schema/Metadata.java +++ b/gencode/java/udmi/schema/Metadata.java @@ -109,7 +109,7 @@ public class Metadata { * Entity Relationships *

* Entity relationships to other devices, keyed by target device ID - * + * */ @JsonProperty("relationships") @JsonPropertyDescription("Entity relationships to other devices, keyed by target device ID") @@ -163,7 +163,7 @@ public class Metadata { * Alarmset Model *

* Alarmset 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 alarms that a device holds - * + * */ @JsonProperty("alarmset") @JsonPropertyDescription("Alarmset 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 alarms that a device holds") diff --git a/gencode/java/udmi/schema/PointPointsetModel.java b/gencode/java/udmi/schema/PointPointsetModel.java index 3d16f7b773..424f56ca3b 100644 --- a/gencode/java/udmi/schema/PointPointsetModel.java +++ b/gencode/java/udmi/schema/PointPointsetModel.java @@ -143,7 +143,7 @@ public class PointPointsetModel { public Map structure; /** * Virtual equipment mapping linking this local point to a remote point in another device - * + * */ @JsonProperty("link") @JsonPropertyDescription("Virtual equipment mapping linking this local point to a remote point in another device") diff --git a/gencode/java/udmi/schema/State.java b/gencode/java/udmi/schema/State.java index 26f91aaf8b..b7bc856ef6 100644 --- a/gencode/java/udmi/schema/State.java +++ b/gencode/java/udmi/schema/State.java @@ -100,7 +100,7 @@ public class State { * Alarmset State *

* A set of alarms reporting telemetry data. - * + * */ @JsonProperty("alarmset") @JsonPropertyDescription("A set of alarms reporting telemetry data.") diff --git a/gencode/presentation/presentation.json b/gencode/presentation/presentation.json index eaf51d5a2d..8a4d0b8c93 100644 --- a/gencode/presentation/presentation.json +++ b/gencode/presentation/presentation.json @@ -1314,32 +1314,12 @@ "41489" ] }, - "alarmset.exclude_units_from_config": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "boolean" - }, "alarmset.exclude_alarms_from_config": { "display": "show", "style": "bold", "section": "alarmset", "type": "boolean" }, - "alarmset.sample_limit_sec": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "integer", - "description": "Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update." - }, - "alarmset.sample_rate_sec": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "integer", - "description": "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." - }, "pointset.exclude_units_from_config": { "display": "show", "style": "bold", diff --git a/gencode/python/udmi/schema/__init__.py b/gencode/python/udmi/schema/__init__.py index 829fd41a42..7801709aaf 100644 --- a/gencode/python/udmi/schema/__init__.py +++ b/gencode/python/udmi/schema/__init__.py @@ -1,5 +1,6 @@ from ._base import * from .access_iot import * +from .alarm_ack import * from .ancillary_properties import * from .bucket import * from .building_config_entity import * @@ -33,6 +34,7 @@ from .configuration_pubber import * from .data_template import * from .dimension import * +from .discovery_alarm_ref import * from .discovery_family import * from .discovery_feature import * from .discovery_ref import * diff --git a/gencode/python/udmi/schema/alarm_ack.py b/gencode/python/udmi/schema/alarm_ack.py new file mode 100644 index 0000000000..47c2755642 --- /dev/null +++ b/gencode/python/udmi/schema/alarm_ack.py @@ -0,0 +1,20 @@ +# generated by datamodel-codegen: +# filename: alarm_ack.json + +from __future__ import annotations + +from dataclasses import dataclass +from typing import Optional + +from ._base import DataModel + + +@dataclass +class AlarmAcknowledgement(DataModel): + """ + Details about an alarm acknowledgement + """ + + timestamp: Optional[str] = None + user: Optional[str] = None + comment: Optional[str] = None diff --git a/gencode/python/udmi/schema/category.py b/gencode/python/udmi/schema/category.py index a1ab38cf72..a763249fac 100644 --- a/gencode/python/udmi/schema/category.py +++ b/gencode/python/udmi/schema/category.py @@ -56,6 +56,9 @@ class Category(Enum): # A `config` parameter for the point is invalid in some way POINTSET_POINT_INVALID = ("pointset.point.invalid", Level.ERROR) + # A `config` parameter for the alarm is invalid in some way + ALARMSET_ALARM_INVALID = ("alarmset.alarm.invalid", Level.ERROR) + # Aspects of a specific network LOCALNET_NETWORK = ("localnet.network", Level.INFO) diff --git a/gencode/python/udmi/schema/config_alarmset.py b/gencode/python/udmi/schema/config_alarmset.py index 6669d31950..f394528c0a 100644 --- a/gencode/python/udmi/schema/config_alarmset.py +++ b/gencode/python/udmi/schema/config_alarmset.py @@ -18,8 +18,4 @@ class AlarmsetConfig(DataModel): timestamp: Optional[str] = None version: Optional[str] = None - state_etag: Optional[str] = None - set_value_expiry: Optional[str] = None - sample_limit_sec: Optional[int] = None - sample_rate_sec: Optional[int] = 300 alarms: Optional[Dict[str, AlarmAlarmsetConfig]] = None diff --git a/gencode/python/udmi/schema/config_alarmset_alarm.py b/gencode/python/udmi/schema/config_alarmset_alarm.py index b46ceeac56..65be22e25a 100644 --- a/gencode/python/udmi/schema/config_alarmset_alarm.py +++ b/gencode/python/udmi/schema/config_alarmset_alarm.py @@ -4,7 +4,7 @@ from __future__ import annotations from dataclasses import dataclass -from typing import Optional, Union +from typing import Optional from ._base import DataModel @@ -12,7 +12,3 @@ @dataclass class AlarmAlarmsetConfig(DataModel): ref: Optional[str] = None - units: Optional[str] = None - set_value: Optional[Union[str, bool, float]] = None - stop_time: Optional[str] = None - cov_increment: Optional[float] = None diff --git a/gencode/python/udmi/schema/config_discovery.py b/gencode/python/udmi/schema/config_discovery.py index 5dd92c2b67..03715a2f47 100644 --- a/gencode/python/udmi/schema/config_discovery.py +++ b/gencode/python/udmi/schema/config_discovery.py @@ -32,3 +32,4 @@ class DiscoveryConfig(DataModel): generation: Optional[str] = None enumerations: Optional[Enumerations] = None families: Optional[Dict[str, FamilyDiscoveryConfig]] = None + alarms: Optional[bool] = None diff --git a/gencode/python/udmi/schema/discovery_alarm_ref.py b/gencode/python/udmi/schema/discovery_alarm_ref.py new file mode 100644 index 0000000000..14eb02a063 --- /dev/null +++ b/gencode/python/udmi/schema/discovery_alarm_ref.py @@ -0,0 +1,25 @@ +# generated by datamodel-codegen: +# filename: discovery_alarm_ref.json + +from __future__ import annotations + +from dataclasses import dataclass +from typing import Optional + +from ._base import DataModel + + +@dataclass +class AlarmRefDiscovery(DataModel): + """ + Object representation for for a single alarm reference discovery + """ + + alarm: Optional[str] = None + name: Optional[str] = None + description: Optional[str] = None + category: Optional[str] = None + severity: Optional[str] = None + requires_ack: Optional[bool] = None + return_to_normal_event: Optional[bool] = None + return_requires_ack: Optional[bool] = None diff --git a/gencode/python/udmi/schema/events_alarmset.py b/gencode/python/udmi/schema/events_alarmset.py index 44730a8e71..4943cc4f8b 100644 --- a/gencode/python/udmi/schema/events_alarmset.py +++ b/gencode/python/udmi/schema/events_alarmset.py @@ -13,11 +13,10 @@ @dataclass class AlarmsetEvents(DataModel): """ - A set of alarms reporting telemetry data. [Alarmset Events Documentation](../docs/messages/alarmset.md#telemetry) + A set of alarm events. """ timestamp: Optional[str] = None version: Optional[str] = None upgraded_from: Optional[str] = None - partial_update: Optional[bool] = None alarms: Optional[Dict[str, AlarmAlarmsetEvents]] = None diff --git a/gencode/python/udmi/schema/events_alarmset_alarm.py b/gencode/python/udmi/schema/events_alarmset_alarm.py index 4e9f5f669d..457ef8284a 100644 --- a/gencode/python/udmi/schema/events_alarmset_alarm.py +++ b/gencode/python/udmi/schema/events_alarmset_alarm.py @@ -4,9 +4,10 @@ from __future__ import annotations from dataclasses import dataclass -from typing import Optional, Union +from typing import Optional from ._base import DataModel +from .alarm_ack import AlarmAcknowledgement @dataclass @@ -15,4 +16,8 @@ class AlarmAlarmsetEvents(DataModel): Object representation for for a single alarm """ - present_value: Optional[Union[str, bool, float]] = None + activate_time: Optional[str] = None + activate_ack: Optional[AlarmAcknowledgement] = None + active: Optional[bool] = None + return_to_normal_time: Optional[str] = None + return_to_normal_ack: Optional[AlarmAcknowledgement] = None diff --git a/gencode/python/udmi/schema/events_discovery.py b/gencode/python/udmi/schema/events_discovery.py index 6fe9294118..28e551ad0d 100644 --- a/gencode/python/udmi/schema/events_discovery.py +++ b/gencode/python/udmi/schema/events_discovery.py @@ -8,10 +8,12 @@ from ._base import DataModel from .ancillary_properties import AncillaryProperties +from .discovery_alarm_ref import AlarmRefDiscovery from .discovery_family import FamilyDiscovery from .discovery_feature import FeatureDiscovery from .discovery_ref import RefDiscovery from .entry import Entry +from .model_alarmset_alarm import AlarmAlarmsetModel from .model_cloud import CloudModel from .model_pointset_point import PointPointsetModel from .state_system_hardware import StateSystemHardware @@ -45,6 +47,8 @@ class DiscoveryEvents(DataModel): devices: Optional[Dict[str, CloudModel]] = None points: Optional[Dict[str, PointPointsetModel]] = None refs: Optional[Dict[str, RefDiscovery]] = None + alarms: Optional[Dict[str, AlarmAlarmsetModel]] = None + alarm_refs: Optional[Dict[str, AlarmRefDiscovery]] = None features: Optional[Dict[str, FeatureDiscovery]] = None cloud_model: Optional[CloudModel] = None system: Optional[System] = None diff --git a/gencode/python/udmi/schema/model_alarmset.py b/gencode/python/udmi/schema/model_alarmset.py index d20efa1252..7d70a45855 100644 --- a/gencode/python/udmi/schema/model_alarmset.py +++ b/gencode/python/udmi/schema/model_alarmset.py @@ -17,7 +17,4 @@ class AlarmsetModel(DataModel): """ alarms: Optional[Dict[str, AlarmAlarmsetModel]] = None - exclude_units_from_config: Optional[bool] = None exclude_alarms_from_config: Optional[bool] = None - sample_limit_sec: Optional[int] = None - sample_rate_sec: Optional[int] = None diff --git a/gencode/python/udmi/schema/model_alarmset_alarm.py b/gencode/python/udmi/schema/model_alarmset_alarm.py index 3229bdd050..3f85b66e1f 100644 --- a/gencode/python/udmi/schema/model_alarmset_alarm.py +++ b/gencode/python/udmi/schema/model_alarmset_alarm.py @@ -4,36 +4,10 @@ from __future__ import annotations from dataclasses import dataclass -from enum import Enum -from typing import Any, Dict, List, Optional +from typing import Dict, Optional from ._base import DataModel -from .discovery_ref import RefDiscovery - - -class Type(Enum): - """ - Expected data type for the alarm - """ - - string = 'string' - boolean = 'boolean' - number = 'number' - - -class BaselineState(Enum): - """ - Expected state when `baseline_value` is set as the `set_value` for this alarm the config message - """ - - applied = 'applied' - updating = 'updating' - overridden = 'overridden' - invalid = 'invalid' - failure = 'failure' - - -Tag = Optional[Any] +from .discovery_alarm_ref import AlarmRefDiscovery @dataclass @@ -42,18 +16,11 @@ class AlarmAlarmsetModel(DataModel): Information about a specific alarm name of the device. """ - units: Optional[str] = None - type: Optional[Type] = None description: Optional[str] = None - writable: Optional[bool] = None - baseline_value: Optional[Any] = None - baseline_tolerance: Optional[float] = None - baseline_state: Optional[BaselineState] = None - range_min: Optional[float] = None - range_max: Optional[float] = None - unchanged_limit_sec: Optional[int] = None - cov_increment: Optional[float] = None + category: Optional[str] = None + severity: Optional[str] = None + requires_ack: Optional[bool] = None + return_to_normal_event: Optional[bool] = None + return_requires_ack: Optional[bool] = None ref: Optional[str] = None - adjunct: Optional[Dict[str, str]] = None - tags: Optional[List[Tag]] = None - structure: Optional[Dict[str, RefDiscovery]] = None + structure: Optional[Dict[str, AlarmRefDiscovery]] = None diff --git a/gencode/python/udmi/schema/state_alarmset_alarm.py b/gencode/python/udmi/schema/state_alarmset_alarm.py index e33ef2650e..7495ebb638 100644 --- a/gencode/python/udmi/schema/state_alarmset_alarm.py +++ b/gencode/python/udmi/schema/state_alarmset_alarm.py @@ -4,32 +4,16 @@ from __future__ import annotations from dataclasses import dataclass -from enum import Enum from typing import Optional from ._base import DataModel from .entry import Entry -class ValueState(Enum): - """ - State of the individual alarm - """ - - initializing = 'initializing' - applied = 'applied' - updating = 'updating' - overridden = 'overridden' - invalid = 'invalid' - failure = 'failure' - - @dataclass class AlarmAlarmsetState(DataModel): """ Object representation for for a single alarm """ - units: Optional[str] = None - value_state: Optional[ValueState] = None status: Optional[Entry] = None diff --git a/misc/bambi/presentation.gld.json b/misc/bambi/presentation.gld.json index eaf51d5a2d..8a4d0b8c93 100644 --- a/misc/bambi/presentation.gld.json +++ b/misc/bambi/presentation.gld.json @@ -1314,32 +1314,12 @@ "41489" ] }, - "alarmset.exclude_units_from_config": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "boolean" - }, "alarmset.exclude_alarms_from_config": { "display": "show", "style": "bold", "section": "alarmset", "type": "boolean" }, - "alarmset.sample_limit_sec": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "integer", - "description": "Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update." - }, - "alarmset.sample_rate_sec": { - "display": "show", - "style": "bold", - "section": "alarmset", - "type": "integer", - "description": "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." - }, "pointset.exclude_units_from_config": { "display": "show", "style": "bold", diff --git a/schema/alarm_ack.json b/schema/alarm_ack.json new file mode 100644 index 0000000000..9e22428318 --- /dev/null +++ b/schema/alarm_ack.json @@ -0,0 +1,26 @@ +{ + "$udmi_version": "1.5.2", + "title": "Alarm Acknowledgement", + "description": "Details about an alarm acknowledgement", + "type": "object", + "$schema": "http://json-schema.org/draft-07/schema#", + "additionalProperties": false, + "properties": { + "timestamp": { + "description": "Timestamp of when the alarm was acknowledged.", + "type": "string", + "format": "date-time" + }, + "user": { + "description": "Name of the user who acknowledged this alarm.", + "type": "string" + }, + "comment": { + "description": "Comment left by the user when acknowledging this alarm.", + "type": "string" + } + }, + "required": [ + "timestamp" + ] +} diff --git a/schema/category.json b/schema/category.json index 75fb22ec83..160b0f4ed2 100644 --- a/schema/category.json +++ b/schema/category.json @@ -19,6 +19,7 @@ { "pattern": "^pointset\\.point\\.overridden$" }, { "pattern": "^pointset\\.point\\.failure$" }, { "pattern": "^pointset\\.point\\.invalid$" }, + { "pattern": "^alarmset\\.alarm\\.invalid$" }, { "pattern": "^localnet\\.network$" }, { "pattern": "^localnet\\.network\\.connect$" }, { "pattern": "^gateway\\.setup\\.attach$" }, diff --git a/schema/config_alarmset.json b/schema/config_alarmset.json index 651de49076..ec58036bbf 100644 --- a/schema/config_alarmset.json +++ b/schema/config_alarmset.json @@ -16,31 +16,8 @@ "description": "Version of the UDMI schema", "type": "string" }, - "state_etag": { - "description": "The `state_etag` of the last _state_ message sent by the device. [Writeback documentation](../docs/specs/sequences/writeback.md)", - "type": "string", - "maxLength": 32 - }, - "set_value_expiry": { - "description": "An expiry for the the device to revert to baseline (no set value). [Writeback documentation](../docs/specs/sequences/writeback.md)", - "type": "string", - "format": "date-time" - }, - "sample_limit_sec": { - "description": "Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.", - "type": "integer", - "minimum": 0, - "maximum": 86400 - }, - "sample_rate_sec": { - "description": "Maximum time between samples for the device to send out a complete update. It can send out updates more frequently than this. Default to 300.", - "type": "integer", - "minimum": 1, - "maximum": 86400, - "default": 300 - }, "alarms": { - "description": "The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device (in both `telemetry` and `state` messages). [Alarmset doumentation](../docs/messages/alarmset.md)", + "description": "The alarms defined in this dictionary is the authoritative source indicating the representative alarms for the device. [Alarmset doumentation](../docs/messages/alarmset.md)", "additionalProperties": false, "existingJavaType": "java.util.HashMap", "patternProperties": { diff --git a/schema/config_alarmset_alarm.json b/schema/config_alarmset_alarm.json index f016204f4a..6577783e77 100644 --- a/schema/config_alarmset_alarm.json +++ b/schema/config_alarmset_alarm.json @@ -7,32 +7,7 @@ "properties": { "ref": { "type": "string", - "description": "Mapping for the alarm to an internal resource (e.g. BACnet object reference)", - "examples": ["AI1106"] - }, - "units": { - "description": "If specified, indicates the units the device should report the data in.", - "type": "string" - }, - "set_value": { - "description": "Used for cloud writeback functionality, this field specifies the value for a given alarm in the device's current units. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer", - "oneOf": [ - { "type": "string" }, - { "type": "boolean" }, - { "type": "number" } - ], - "examples": [22.4] - }, - "stop_time": { - "description": "RFC 3339 timestamp for the specified alarm write easing to stop", - "type": "string", - "format": "date-time", - "examples": ["2019-01-17T14:02:29.364Z"] - }, - "cov_increment": { - "type": "number", - "description": "The CoV (change of value) increment, which when set, enables CoV on the alarm and defines the minimum change in present value of the respective alarm before an update is published", - "minimum": 0 + "description": "Mapping for the alarm to its internal counterpart" } } } diff --git a/schema/config_discovery.json b/schema/config_discovery.json index dd817839d2..e463b5e133 100644 --- a/schema/config_discovery.json +++ b/schema/config_discovery.json @@ -39,6 +39,10 @@ "$ref": "file:config_discovery_family.json" } } + }, + "alarms": { + "description": "Indicates whether or not to discover alarms.", + "type": "boolean" } } } diff --git a/schema/discovery_alarm_ref.json b/schema/discovery_alarm_ref.json new file mode 100644 index 0000000000..fa6faaa913 --- /dev/null +++ b/schema/discovery_alarm_ref.json @@ -0,0 +1,43 @@ +{ + "$udmi_version": "1.5.2", + "title": "Alarm Ref Discovery", + "description": "Object representation for for a single alarm reference discovery", + "type": "object", + "$schema": "http://json-schema.org/draft-07/schema#", + "additionalProperties": false, + "properties": { + "alarm": { + "description": "Alarm descriptor for this alarm", + "type": "string", + "pattern": "^[a-z][a-z0-9]*(_[a-z0-9]+)*$" + }, + "name": { + "description": "Friendly name for the reference, if known", + "type": "string" + }, + "description": { + "description": "Detailed description of this alarm", + "type": "string" + }, + "category": { + "description": "Category that this alarm is classified as", + "type": "string" + }, + "severity": { + "description": "Severity of the alarm", + "type": "string" + }, + "requires_ack": { + "description": "Indicates whether or not alarm activation requries acknowledgement.", + "type": "boolean" + }, + "return_to_normal_event": { + "description": "Indicates whether or not the alarm sends return-to-normal events.", + "type": "boolean" + }, + "return_requires_ack": { + "description": "Indicates whether or not returning to normal requries acknowledgement.", + "type": "boolean" + } + } +} diff --git a/schema/events_alarmset.json b/schema/events_alarmset.json index bae6ba8865..0da24eba19 100644 --- a/schema/events_alarmset.json +++ b/schema/events_alarmset.json @@ -1,14 +1,14 @@ { "$udmi_version": "1.5.2", "title": "Alarmset Events", - "description": "A set of alarms reporting telemetry data. [Alarmset Events Documentation](../docs/messages/alarmset.md#telemetry)", + "description": "A set of alarm events.", "$section": "Messages", "type": "object", "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { "timestamp": { - "description": "RFC 3339 UTC timestamp the telemetry event was generated", + "description": "RFC 3339 UTC timestamp the alarm event was generated", "type": "string", "format": "date-time", "examples": ["2019-01-17T14:02:29.364Z"] @@ -21,10 +21,6 @@ "description": "Original version of schema pre-upgrade", "type": "string" }, - "partial_update": { - "description": "Indicates if this is a partial update (only some alarms may be included)", - "type": "boolean" - }, "alarms": { "description": "Collection of alarm names, defining the representative alarm set for this device.", "additionalProperties": false, diff --git a/schema/events_alarmset_alarm.json b/schema/events_alarmset_alarm.json index 4d63bc1ef2..c7da873611 100644 --- a/schema/events_alarmset_alarm.json +++ b/schema/events_alarmset_alarm.json @@ -6,17 +6,31 @@ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { - "present_value": { - "description": "The specific alarm data reading. If the value is numeric, then the type must be integer or number. If the value is an integer, it should be represented as type integer", - "oneOf": [ - { "type": "string" }, - { "type": "boolean" }, - { "type": "number" } - ], - "examples": [24.1, "running", 4] + "activate_time": { + "description": "Timestamp of when the alarm became active.", + "type": "string", + "format": "date-time" + }, + "activate_ack": { + "description": "Acknowledgement of the alarm activation.", + "$ref": "file:alarm_ack.json" + }, + "active": { + "description": "Indicates whether or not the alarm conditions are currently active.", + "type": "boolean" + }, + "return_to_normal_time": { + "description": "Timestamp of when the alarm conditions returned to normal.", + "type": "string", + "format": "date-time" + }, + "return_to_normal_ack": { + "description": "Acknowledgement of the alarm returning to normal.", + "$ref": "file:alarm_ack.json" } }, "required": [ - "present_value" + "activate_time", + "active" ] } diff --git a/schema/events_discovery.json b/schema/events_discovery.json index 198233ae1d..1740845683 100644 --- a/schema/events_discovery.json +++ b/schema/events_discovery.json @@ -94,6 +94,26 @@ } } }, + "alarms": { + "description": "Information about a specific alarm name of the device.", + "additionalProperties": false, + "existingJavaType": "java.util.Map", + "patternProperties": { + "^[a-z][a-z0-9]*(_[a-z0-9]+)*$": { + "$ref": "file:model_alarmset_alarm.json#" + } + } + }, + "alarm_refs": { + "description": "Collection of alarm references", + "additionalProperties": false, + "existingJavaType": "java.util.Map", + "patternProperties": { + "^[-_.:/a-zA-Z0-9]+$": { + "$ref": "file:discovery_alarm_ref.json#" + } + } + }, "features": { "description": "Discovery of features supported by this device.", "additionalProperties": false, diff --git a/schema/model_alarmset.json b/schema/model_alarmset.json index 43e2281b5b..ceba62d5ed 100644 --- a/schema/model_alarmset.json +++ b/schema/model_alarmset.json @@ -25,39 +25,12 @@ } } }, - "exclude_units_from_config": { - "type": "boolean", - "$presentation": { - "display": "show", - "style": "bold" - } - }, "exclude_alarms_from_config": { "type": "boolean", "$presentation": { "display": "show", "style": "bold" } - }, - "sample_limit_sec": { - "description": "Minimum time between sample updates for the device (including complete and COV updates). Updates more frequent than this should be coalesced into one update.", - "type": "integer", - "minimum": 0, - "maximum": 86400, - "$presentation": { - "display": "show", - "style": "bold" - } - }, - "sample_rate_sec": { - "description": "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.", - "type": "integer", - "minimum": 1, - "maximum": 86400, - "$presentation": { - "display": "show", - "style": "bold" - } } }, "required": [ diff --git a/schema/model_alarmset_alarm.json b/schema/model_alarmset_alarm.json index 69f6879319..cd6f8175da 100644 --- a/schema/model_alarmset_alarm.json +++ b/schema/model_alarmset_alarm.json @@ -6,92 +6,41 @@ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { - "units": { - "description": "Expected unit configuration for the alarm", - "type": "string" - }, - "type": { - "description": "Expected data type for the alarm", - "enum": ["string", "boolean", "number"] - }, "description": { "description": "Detailed description of this alarm", "type": "string" }, - "writable": { - "description": "Indicates if this alarm is writable (else read-only)", - "type": "boolean" - }, - "baseline_value": { - "description": "Represents the expected baseline value of the alarm", - "examples": [22] - }, - "baseline_tolerance": { - "type": "number", - "description": "Maximum deviation from `baseline_value`", - "examples": [2] - }, - "baseline_state": { - "description": "Expected state when `baseline_value` is set as the `set_value` for this alarm the config message", - "enum": [ - "applied", - "updating", - "overridden", - "invalid", - "failure" - ] + "category": { + "description": "Category that this alarm is classified as", + "type": "string" }, - "range_min": { - "description": "Represents the lower bound of the error threshold for a alarm", - "type": "number", - "examples": [0] + "severity": { + "description": "Severity of the alarm", + "type": "string" }, - "range_max": { - "description": "Represents the upper bound of the error threshold for a alarm", - "type": "number", - "examples": [100] + "requires_ack": { + "description": "Indicates whether or not alarm activation requries acknowledgement.", + "type": "boolean" }, - "unchanged_limit_sec": { - "description": "Represents the limit in seconds that a alarm can be unchanged for", - "type": "integer", - "examples": [3600] + "return_to_normal_event": { + "description": "Indicates whether or not the alarm sends return-to-normal events.", + "type": "boolean" }, - "cov_increment": { - "description": "Triggering threshold for partial cov update publishing", - "examples": [1], - "type": "number" + "return_requires_ack": { + "description": "Indicates whether or not returning to normal requries acknowledgement.", + "type": "boolean" }, "ref": { - "description": "Mapping for the alarm to an internal resource (e.g. BACnet object reference)", - "type": "string", - "examples": ["AI3", "400070"] - }, - "adjunct": { - "type": "object", - "existingJavaType": "java.util.Map", - "additionalProperties": false, - "patternProperties": { - "^[a-z_]+$": { - "type": "string" - } - } - }, - "tags":{ - "description": "Tags assosciated with the alarm", - "type": "array", - "uniqueItems": true, - "items": { - "pattern": "^[a-z0-9]+$" - }, - "examples": [["lighting"], ["energy", "hvac"]] + "description": "Mapping for the alarm to its internal counterpart", + "type": "string" }, "structure": { - "description": "Collection of family alarm information", + "description": "Collection of alarm information", "additionalProperties": false, - "existingJavaType": "java.util.Map", + "existingJavaType": "java.util.Map", "patternProperties": { "^[-_.:/a-zA-Z0-9]+$": { - "$ref": "file:discovery_ref.json#" + "$ref": "file:discovery_alarm_ref.json#" } } } diff --git a/schema/state_alarmset_alarm.json b/schema/state_alarmset_alarm.json index 606dee06b6..c41d2f33d8 100644 --- a/schema/state_alarmset_alarm.json +++ b/schema/state_alarmset_alarm.json @@ -6,21 +6,6 @@ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": { - "units": { - "description": "If specified, indicates a programmed alarm unit. If empty, means unspecified or matches configured alarm.", - "type": "string" - }, - "value_state": { - "description": "State of the individual alarm", - "enum": [ - "initializing", - "applied", - "updating", - "overridden", - "invalid", - "failure" - ] - }, "status": { "description": "Optional status information about this alarm, subject to log severity level", "$ref": "file:entry.json"