Merge pull request #72 from boschrexroth/origin/DOC-update-examples

Origin/doc update examples
boschrexroth · Nov 27, 2023 · 705f55e · 705f55e
2 parents e7fb667 + ea51e22
commit 705f55e
Show file tree

Hide file tree

Showing 24 changed files with 54 additions and 13 deletions.
diff --git a/doc/EXAMPLES.md b/doc/EXAMPLES.md
diff --git a/doc/images/datalayer_request_examples.png b/doc/images/datalayer_request_examples.png
diff --git a/doc/images/example-basic-read.png b/doc/images/example-basic-read.png
diff --git a/doc/images/example-read-with-attribute.png b/doc/images/example-read-with-attribute.png
diff --git a/doc/images/examples_catch_error.png → doc/images/examples-catch-error.png b/doc/images/examples_catch_error.png → doc/images/examples-catch-error.png
diff --git a/...les_diagnosis_confirm_error_dashboard.png → ...les-diagnosis-confirm-error-dashboard.png b/...les_diagnosis_confirm_error_dashboard.png → ...les-diagnosis-confirm-error-dashboard.png
diff --git a/...ages/examples_diagnosis_confirm_error.png → ...ages/examples-diagnosis-confirm-error.png b/...ages/examples_diagnosis_confirm_error.png → ...ages/examples-diagnosis-confirm-error.png
diff --git a/...es_diagnosis_confirm_errors_dashboard.png → ...es-diagnosis-confirm-errors-dashboard.png b/...es_diagnosis_confirm_errors_dashboard.png → ...es-diagnosis-confirm-errors-dashboard.png
diff --git a/...ges/examples_diagnosis_confirm_errors.png → ...ges/examples-diagnosis-confirm-errors.png b/...ges/examples_diagnosis_confirm_errors.png → ...ges/examples-diagnosis-confirm-errors.png
diff --git a/doc/images/examples-diagnosis-get-detail-diag-text-dashboard.png b/doc/images/examples-diagnosis-get-detail-diag-text-dashboard.png
diff --git a/doc/images/examples-diagnosis-get-detail-diag-text.png b/doc/images/examples-diagnosis-get-detail-diag-text.png
diff --git a/doc/images/examples-diagnosis-get-main-diag-text-dashboard.png b/doc/images/examples-diagnosis-get-main-diag-text-dashboard.png
diff --git a/doc/images/examples-diagnosis-get-main-diag-text.png b/doc/images/examples-diagnosis-get-main-diag-text.png
diff --git a/doc/images/examples-diagnosis-read-pending-diagnostics-dashboard.png b/doc/images/examples-diagnosis-read-pending-diagnostics-dashboard.png
diff --git a/doc/images/examples-diagnosis-read-pending-diagnostics.png b/doc/images/examples-diagnosis-read-pending-diagnostics.png
diff --git a/doc/images/examples_get_token.png → doc/images/examples-get-token.png b/doc/images/examples_get_token.png → doc/images/examples-get-token.png
diff --git a/doc/images/examples_import_nodes.png → doc/images/examples-import-nodes.png b/doc/images/examples_import_nodes.png → doc/images/examples-import-nodes.png
diff --git a/doc/images/examples_read_CPU_utilisation.png → doc/images/examples-read-CPU-utilisation.png b/doc/images/examples_read_CPU_utilisation.png → doc/images/examples-read-CPU-utilisation.png
diff --git a/...amples_set_request_properties_via_msg.png → ...amples-set-request-properties-via-msg.png b/...amples_set_request_properties_via_msg.png → ...amples-set-request-properties-via-msg.png
diff --git a/...es/examples_subscribe_CPU_utilisation.png → ...es/examples-subscribe-CPU-utilisation.png b/...es/examples_subscribe_CPU_utilisation.png → ...es/examples-subscribe-CPU-utilisation.png
diff --git a/doc/images/node-appearance.png b/doc/images/node-appearance.png
diff --git a/examples/Diagnosis - Get detail diagnostic text.json b/examples/Diagnosis - Get detail diagnostic text.json
@@ -0,0 +1 @@
+[{"id":"24e389ee88bbd972","type":"ctrlx-datalayer-request","z":"bf7a3579c5656113","device":"7b877229.678964","method":"READ","path":"","payloadFormat":"value_type","name":"Read detail diag text","x":560,"y":640,"wires":[["9cfc3279057259fe"]]},{"id":"96de7236184e1636","type":"function","z":"bf7a3579c5656113","name":"make value","func":"var newMsg = {}\nvar myMainDiagNumber = \"091F2006\"\nvar myDetailDiagNumber = \"0C560107\"\nnewMsg.path = \"diagnosis/get/text/detailed?data={ \\\"type\\\": \\\"object\\\", \\\"value\\\": { \\\"detailedDiagnosisNumber\\\": \\\"\" + myDetailDiagNumber + \"\\\", \\\"relatedMainDiagnosisNumber\\\": \\\"\" + myMainDiagNumber + \"\\\" } }\"\nreturn newMsg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":370,"y":640,"wires":[["24e389ee88bbd972"]]},{"id":"e45d515b6c331225","type":"comment","z":"bf7a3579c5656113","name":"Example: Get detail diagnosis text","info":"","x":180,"y":600,"wires":[]},{"id":"3331e124823b565a","type":"inject","z":"bf7a3579c5656113","name":"Manual Trigger","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":160,"y":680,"wires":[["96de7236184e1636"]]},{"id":"efcdc0eecbd37d40","type":"ui_button","z":"bf7a3579c5656113","name":"","group":"cd7a7d59d153b666","order":1,"width":"3","height":"1","passthru":false,"label":"Read detail diag text","tooltip":"","color":"","bgcolor":"","className":"","icon":"","payload":"","payloadType":"str","topic":"topic","topicType":"msg","x":160,"y":640,"wires":[["96de7236184e1636"]]},{"id":"9cfc3279057259fe","type":"ui_text","z":"bf7a3579c5656113","group":"cd7a7d59d153b666","order":2,"width":"6","height":"2","name":"","label":"Detail diag text","format":"{{msg.payload.value}}","layout":"col-center","className":"","x":760,"y":640,"wires":[]},{"id":"7b877229.678964","type":"ctrlx-config","name":"localhost","hostname":"localhost","debug":false},{"id":"cd7a7d59d153b666","type":"ui_group","name":"Diagnosis","tab":"9cba2148.8c9148","order":9,"disp":true,"width":"6","collapse":false,"className":""},{"id":"9cba2148.8c9148","type":"ui_tab","name":"Examples","icon":"dashboard","order":7,"disabled":false,"hidden":false}]
diff --git a/examples/Diagnosis - Get main diagnostic text.json b/examples/Diagnosis - Get main diagnostic text.json
@@ -0,0 +1 @@
+[{"id":"24e389ee88bbd972","type":"ctrlx-datalayer-request","z":"bf7a3579c5656113","device":"7b877229.678964","method":"READ","path":"","payloadFormat":"value_type","name":"Read main diag text","x":560,"y":640,"wires":[["9cfc3279057259fe"]]},{"id":"96de7236184e1636","type":"function","z":"bf7a3579c5656113","name":"make value","func":"var newMsg = {}\nvar myMainDiagNumber = \"091F2006\"\nnewMsg.path = \"diagnosis/get/text/main?data={ \\\"type\\\": \\\"object\\\", \\\"value\\\": { \\\"mainDiagnosisNumber\\\": \\\"\" + myMainDiagNumber + \"\\\" } }\"\nreturn newMsg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":370,"y":640,"wires":[["24e389ee88bbd972"]]},{"id":"e45d515b6c331225","type":"comment","z":"bf7a3579c5656113","name":"Example: Get main diagnosis text","info":"","x":170,"y":600,"wires":[]},{"id":"3331e124823b565a","type":"inject","z":"bf7a3579c5656113","name":"Manual Trigger","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":160,"y":680,"wires":[["96de7236184e1636"]]},{"id":"efcdc0eecbd37d40","type":"ui_button","z":"bf7a3579c5656113","name":"","group":"cd7a7d59d153b666","order":1,"width":"3","height":"1","passthru":false,"label":"Read main diag text","tooltip":"","color":"","bgcolor":"","className":"","icon":"","payload":"","payloadType":"str","topic":"topic","topicType":"msg","x":160,"y":640,"wires":[["96de7236184e1636"]]},{"id":"9cfc3279057259fe","type":"ui_text","z":"bf7a3579c5656113","group":"cd7a7d59d153b666","order":2,"width":"6","height":"2","name":"","label":"Main diag text","format":"{{msg.payload.value}}","layout":"col-center","className":"","x":760,"y":640,"wires":[]},{"id":"7b877229.678964","type":"ctrlx-config","name":"localhost","hostname":"localhost","debug":false},{"id":"cd7a7d59d153b666","type":"ui_group","name":"Diagnosis","tab":"9cba2148.8c9148","order":9,"disp":true,"width":"6","collapse":false,"className":""},{"id":"9cba2148.8c9148","type":"ui_tab","name":"Examples","icon":"dashboard","order":7,"disabled":false,"hidden":false}]
diff --git a/examples/Diagnosis - Read all pending diagnostics.json b/examples/Diagnosis - Read all pending diagnostics.json
@@ -0,0 +1 @@
+[{"id":"af0c0102e0191bc8","type":"ctrlx-datalayer-subscribe","z":"bf7a3579c5656113","subscription":"632bcc2.eddf134","path":"diagnosis/get/actual/list","name":"Read pending diagnostics","x":310,"y":480,"wires":[["367e1ba061c76fec"]]},{"id":"367e1ba061c76fec","type":"function","z":"bf7a3579c5656113","name":"make value","func":"var newMsg = {}\nvar myArray = msg.payload.listDiagnosisIdentificationWithTimestamp\nnewMsg.payload = \"Pending diagnostics:<br>\"\nfor (let index = 0; index < (myArray.length -1); ++index) {\n    newMsg.payload += index + \": \" \n    + myArray[index].diagnosisIdentification.mainDiagnosisNumber \n    + \", \" + myArray[index].diagnosisIdentification.detailedDiagnosisNumber \n    + \", \" + myArray[index].diagnosisIdentification.entity + \";<br>\"\n}\nreturn newMsg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":510,"y":480,"wires":[["8eac940b52bde5ae"]]},{"id":"8eac940b52bde5ae","type":"ui_template","z":"bf7a3579c5656113","group":"cd7a7d59d153b666","name":"Show pending diagnostics","order":4,"width":"6","height":"2","format":"<div ng-bind-html=\"msg.payload\"></div>","storeOutMessages":true,"fwdInMessages":true,"resendOnRefresh":true,"templateScope":"local","className":"","x":720,"y":480,"wires":[[]]},{"id":"308321925688e5da","type":"comment","z":"bf7a3579c5656113","name":"Example: Get main diagnosis text","info":"","x":330,"y":440,"wires":[]},{"id":"632bcc2.eddf134","type":"ctrlx-config-subscription","device":"7b877229.678964","name":"Sub_Default","publishIntervalMs":""},{"id":"cd7a7d59d153b666","type":"ui_group","name":"Diagnosis","tab":"9cba2148.8c9148","order":9,"disp":true,"width":"6","collapse":false,"className":""},{"id":"7b877229.678964","type":"ctrlx-config","name":"localhost","hostname":"localhost","debug":false},{"id":"9cba2148.8c9148","type":"ui_tab","name":"Examples","icon":"dashboard","order":7,"disabled":false,"hidden":false}]