From 7c76a5bd141d7aff826918ef5659e92f69891dd5 Mon Sep 17 00:00:00 2001 From: "Bryan T. Richardson" Date: Mon, 29 Jul 2024 15:46:00 -0600 Subject: [PATCH] added README --- src/go/intercom/README.md | 43 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 src/go/intercom/README.md diff --git a/src/go/intercom/README.md b/src/go/intercom/README.md new file mode 100644 index 0000000..66e9a60 --- /dev/null +++ b/src/go/intercom/README.md @@ -0,0 +1,43 @@ +# Intercom Module + +> TODO: improve upon this README + +The `intercom` module uses MQTT to extend an OT-sim device's message bus data +to other OT-sim devices. This is helpful when, for example, multiple other +OT-sim devices that are being used as HMI servers need to talk to the same +remote OT-sim device. This could be done using DNP3, for example, but the DNP3 +module only supports a single client connection. Using the `intercom` module +also cuts down on configuration requirements since it simply mirrors all tags +automatically. + +## TODO + +* [ ] Update client and broker implementations to default to the following settings. + +``` + + :1883 + + true + false + + + false + true + + +``` + +``` + + tcp://10.2.2.2:1883 + + false + true + + + true + false + + +```