stinger-ipc 0.0.5__tar.gz → 0.0.8__tar.gz

{stinger_ipc-0.0.5/stinger_ipc.egg-info → stinger_ipc-0.0.8}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.5
+Version: 0.0.8
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jacobs-jinja-too>=0.1.0
+Requires-Dist: jacobs-jinja-too>=0.2.4
 Requires-Dist: packaging>=25.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "stinger-ipc"
-version = "0.0.5"
+version = "0.0.8"
 description = "Tools to create code to do IPC over MQTT"
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
-    "jacobs-jinja-too>=0.1.0",
+    "jacobs-jinja-too>=0.2.4",
     "packaging>=25.0",
     "pydantic>=2.11.7",
     "pyyaml>=6.0.2",
@@ -45,3 +45,4 @@ stingeripc = [
 pythongen = "stingeripc.tools.python_generator:run"
 rustgen = "stingeripc.tools.rust_generator:main"
 markdowngen = "stingeripc.tools.markdown_generator:run"
+stinger = "stingeripc.tools.cli:run"

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8/stinger_ipc.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.5
+Version: 0.0.8
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jacobs-jinja-too>=0.1.0
+Requires-Dist: jacobs-jinja-too>=0.2.4
 Requires-Dist: packaging>=25.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stinger_ipc.egg-info/SOURCES.txt

@@ -30,6 +30,9 @@ stingeripc/templates/cpp/include/structs.hpp.jinja2
 stingeripc/templates/cpp/src/broker.cpp.jinja2
 stingeripc/templates/cpp/src/client.cpp.jinja2
 stingeripc/templates/cpp/src/server.cpp.jinja2
+stingeripc/templates/html/app.js.jinja2
+stingeripc/templates/html/index.html.jinja2
+stingeripc/templates/html/styles.css.jinja2
 stingeripc/templates/markdown/index.md.jinja2
 stingeripc/templates/python/__init__.py.jinja2
 stingeripc/templates/python/client.py.jinja2
@@ -42,15 +45,16 @@ stingeripc/templates/rust/Cargo.toml.jinja2
 stingeripc/templates/rust/client/Cargo.toml.jinja2
 stingeripc/templates/rust/client/examples/client.rs.jinja2
 stingeripc/templates/rust/client/src/lib.rs.jinja2
-stingeripc/templates/rust/connection/Cargo.toml.jinja2
-stingeripc/templates/rust/connection/examples/pub_and_recv.rs.jinja2
-stingeripc/templates/rust/connection/src/handler.rs.jinja2
-stingeripc/templates/rust/connection/src/lib.rs.jinja2
-stingeripc/templates/rust/connection/src/payloads.rs.jinja2
+stingeripc/templates/rust/payloads/Cargo.toml.jinja2
+stingeripc/templates/rust/payloads/examples/pub_and_recv.rs.jinja2
+stingeripc/templates/rust/payloads/src/handler.rs.jinja2
+stingeripc/templates/rust/payloads/src/lib.rs.jinja2
+stingeripc/templates/rust/payloads/src/payloads.rs.jinja2
 stingeripc/templates/rust/server/Cargo.toml.jinja2
 stingeripc/templates/rust/server/examples/server.rs.jinja2
 stingeripc/templates/rust/server/src/lib.rs.jinja2
 stingeripc/tools/__init__.py
+stingeripc/tools/cli.py
 stingeripc/tools/markdown_generator.py
 stingeripc/tools/python_generator.py
 stingeripc/tools/rust_generator.py

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stinger_ipc.egg-info/entry_points.txt

@@ -2,3 +2,4 @@
 markdowngen = stingeripc.tools.markdown_generator:run
 pythongen = stingeripc.tools.python_generator:run
 rustgen = stingeripc.tools.rust_generator:main
+stinger = stingeripc.tools.cli:run

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stinger_ipc.egg-info/requires.txt

@@ -1,4 +1,4 @@
-jacobs-jinja-too>=0.1.0
+jacobs-jinja-too>=0.2.4
 packaging>=25.0
 pydantic>=2.11.7
 pyyaml>=6.0.2

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stingeripc/components.py

@@ -203,9 +203,9 @@ class ArgEnum(Arg):
             retval = f"{self._enum.class_name}::{stringcase.constcase(value)}"
         elif lang == "rust":
             if self.optional:
-                retval = f"Some(connection::payloads::{self._enum.class_name}::{stringmanip.upper_camel_case(value)})"
+                retval = f"Some({self._enum.class_name}::{stringmanip.upper_camel_case(value)})"
             else:
-                retval = f"connection::payloads::{self._enum.class_name}::{stringmanip.upper_camel_case(value)}"
+                retval = f"{self._enum.class_name}::{stringmanip.upper_camel_case(value)}"
         random.setstate(random_state)
         return retval
 
@@ -646,7 +646,7 @@ class Property(InterfaceComponent):
         if len(self._arg_list) == 1:
             return self._arg_list[0].rust_type
         else:
-            return f"connection::payloads::{self.rust_local_type}"
+            return f"{self.rust_local_type}"
 
     @property
     def arg_list(self) -> list[Arg]:
@@ -740,7 +740,7 @@ class InterfaceEnum:
 
     @property
     def rust_type(self) -> str:
-        return f"connection::payloads::{self.rust_local_type}"
+        return f"{self.rust_local_type}"
 
     @property
     def cpp_type(self) -> str:
@@ -811,7 +811,7 @@ class InterfaceStruct:
 
     @property
     def rust_type(self) -> str:
-        return f"connection::payloads::{self.rust_local_type}"
+        return f"{self.rust_local_type}"
 
     @property
     def cpp_type(self) -> str:

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stingeripc/lang_symb.py

@@ -1,24 +1,26 @@
 
 from jacobsjinjatoo import stringmanip
+import stringcase
 
 class PythonSymbols:
     def __init__(self):
         ...
 
-    @property
-    def package_name(self):
-        return f"{stringmanip.lower_camel_case(self._iface.name).lower()}ipc"
-
     @property
     def type_definition_module(self) -> str:
         return "stinger_types"
 
+
 class PythonInterfaceSymbols(PythonSymbols):
 
     def __init__(self, interface):
         super().__init__()
         self._iface = interface
 
+    @property
+    def package_name(self):
+        return f"{stringmanip.lower_camel_case(self._iface.name).lower()}ipc"
+
     @property
     def client_class_name(self) -> str:
         """ Name of the python class for the interface client."""
@@ -65,6 +67,21 @@ class RustInterfaceSymbols(RustSymbols):
         super().__init__()
         self._iface = interface
 
+    @property
+    def client_package_name(self) -> str:
+        """ Name of the rust package for the interface client."""
+        return f"{stringcase.snakecase(self._iface.name)}_client"
+
+    @property
+    def server_package_name(self) -> str:
+        """ Name of the rust package for the interface server."""
+        return f"{stringcase.snakecase(self._iface.name)}_server"
+    
+    @property
+    def common_package_name(self) -> str:
+        """ Name of the rust package for the interface common types."""
+        return f"{stringcase.snakecase(self._iface.name)}_types"
+
     @property
     def client_struct_name(self) -> str:
         """ Name of the rust struct for the interface client."""

stinger_ipc-0.0.8/stingeripc/templates/html/app.js.jinja2

@@ -0,0 +1,125 @@
+const clientId = "{{stinger.name}}-web-" + new Date().getTime();
+
+const signalSubIdStart = 1;
+const propertySubIdStart = {{10 + stinger.signals|length}};
+
+function makeRequestProperties() {
+    const correlationData = Math.random().toString(16).substr(2, 8);
+    return {
+        "contentType": "application/json",
+        "correlationData": correlationData,
+        "responseTopic": responseTopic + correlationData
+    }
+}
+
+var app = angular.module("myApp", []);
+
+app.controller("myCtrl", function ($scope, $filter, $location) {
+
+    console.log("Running app");
+
+    var subscription_state = 0;
+
+    $scope.timePattern = new RegExp("^[0-2][0-9]:[0-5][0-9]$");
+    $scope.online = false;
+    $scope.signals = { {%-for sig_name, signal in stinger.signals.items() %}
+        "{{sig_name | lowerCamelCase}}": {
+            "subscription_id": null,
+            "name": "{{sig_name}}",
+            "received": [],
+            "mqtt_topic": "{{signal.topic}}"
+        }{%if not loop.last%},{%endif%}
+    {%endfor-%} };
+
+    $scope.properties = {
+
+    };
+
+    $scope.console = {
+        showing: false,
+        requests: []
+    }
+
+    $scope.showoutput = false;
+    $scope.linuxoutput = '';
+
+    const brokerUrl = 'ws://' + location.hostname + ':' + location.port + '/ws'
+
+    const connectOptions = {
+        keepAlive: 60,
+        clientId: clientId,
+        protocolId: 'MQTT',
+        protocolVersion: 5,
+        clean: true
+    };
+
+    var client = mqtt.connect(brokerUrl, connectOptions);
+
+    client.on('close', function() {
+        console.log("Connection Lost");
+    });
+
+    function publish(name, topic, payload, qos) {
+        console.log(name + " Sending to " + topic);
+        console.log(payload);
+        let props = makeRequestProperties();
+        props 
+        $scope.console.requests.unshift({"name":name, "correlationData":props.correlationData, "topic": topic, "payload": payload, "response": null, "requestTime": Date.now()});
+        client.publish(topic, payload, { "qos": qos, retain: false, properties: props});
+        return props.correlationData;
+    }
+
+    client.on('message', function(topic, message, packet) {
+        console.log("Message Arrived: " + topic);
+
+        const subid = packet.properties.subscriptionIdentifier;
+
+        if (subid >= signalSubIdStart && subid < propertySubIdStart) {
+            const signal_index = subid - signalSubIdStart;
+            console.log("Signal index: " + signal_index);
+            $scope.data.signals[signal_index] = JSON.parse(message.toString());
+        } else if (subid >= propertySubIdStart && subid < propertySubIdStart + {{stinger.properties|length}}) {
+            const prop_index = subid - propertySubIdStart;
+            console.log("Property index: " + prop_index);
+            $scope.data.properties[prop_index] = JSON.parse(message.toString());
+        }
+
+        var obj;
+        if (message.toString().length == 0) {
+            obj = null;
+        } else {
+            obj = JSON.parse(message.toString());
+        }
+        console.log(obj);
+
+        $scope.$apply();
+    });
+
+    client.on('connect', function() {
+        console.log("Connected with ", client);
+        {%for signal_name, signal in stinger.signals.items() %}
+        const {{sig_name}}_sub_opts = {
+            "qos": 1,
+            "properties": {
+                "subscriptionIdentifier": (signalSubIdStart + {{loop.index}})
+            }
+        };
+        client.subscribe("{{signal.topic}}", {{sig_name}}_sub_opts);
+        console.log("Subscribing to {{signal.topic}} with id {{loop.index}}");
+        {%endfor%}
+        {%for prop_name, prop in stinger.properties.items() %}
+        const {{prop_name}}_sub_opts = {
+            "qos": 1,
+            "properties": {
+                "subscriptionIdentifier": (propertySubIdStart + {{loop.index}})
+            }
+        };
+        client.subscribe("{{prop.value_topic}}", {{prop_name}}_sub_opts);
+        console.log("Subscribing to {{prop.value_topic}} with id {{loop.index + stinger.signals|length}}");
+        {%endfor%}
+        subscription_state = 1;
+        $scope.$apply();
+    });
+
+ 
+});

stinger_ipc-0.0.8/stingeripc/templates/html/index.html.jinja2

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Standalone Devices (Demo)</title>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link href="https://cdn.jsdelivr.net/npm/@mdi/font@7.2.96/css/materialdesignicons.min.css" rel="stylesheet" />
+    <link rel="stylesheet" href="./style.css" />
+  </head>
+  <body ng-app="myApp" ng-controller="myCtrl">
+    <div class="infobox-background" ng-show="!online || showoutput" id="offline">Connecting</div>
+    {%for sig_name, sig in stinger.signals.items() %}
+    <div class="signal-box" id="signal-box-{{ sig_name }}">
+        <h3 class="signal-title">{{ sig_name }}</h3>
+        <div class="signal-doc">{%if sig.documentation %}
+{%markdown%}
+{{ sig.documentation }}
+{%endmarkdown%}
+        {%endif%}</div>
+        <div class="last-signal-value" ng-show="signals['{{sig_name|lowerCamelCase}}']"></div>
+    </div>
+    {%endfor%}
+    {%raw%}
+    <div id="console" ng-class="{ 'expanded' : (console.showing) }">
+      <div class="top" ng-click=" console.showing = !console.showing ">Request Console <span ng-show="console.showing && console.requests.length > 0" ng-click="console.requests = []"> - Clear</span>
+        <p class="expanded-toggle">{{ console.showing ? 'Hide' : 'Show' }}</p>
+      </div>
+      <div id="request-list">
+        <p ng-repeat="msg in console.requests" class="entry">
+          <strong>{{msg.name}}:</strong> <em>{{msg.topic}}</em> <span class="elapsedTime" ng-show="msg.responseTime">{{msg.responseTime - msg.requestTime}}ms</span><span class="elapsedTime" ng-show="msg.eventTime">{{msg.eventTime}}</span>
+          <span class="outgoing" ng-show="msg.payload">{{msg.payload}}</span>
+          <span class="incoming" ng-show="msg.response">{{msg.response}}</span>
+          <span ng-repeat="result in msg.results" class="action-result">{{result}}</span>
+        </p>
+      </div>
+    </div>
+    {%endraw%}
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.8.2/angular.min.js"></script>
+    <script src="https://unpkg.com/mqtt@5.14.0/dist/mqtt.min.js"></script>
+    <script src="app.js"></script>
+  </body>
+</html>

stinger_ipc-0.0.8/stingeripc/templates/html/styles.css.jinja2

@@ -0,0 +1,187 @@
+{%raw%}
+@charset "UTF-8";
+@import url("https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700");
+
+body {
+    font-family: "Open Sans", sans-serif;
+}
+
+.clickable:hover {
+    text-decoration: underline;
+    color: blue;
+}
+
+
+.modeoption {
+    margin: 5px;
+}
+
+.pending {
+    color: #aaa;
+    animation: color-transition 1s ease-in-out infinite alternate;
+}
+  
+@keyframes color-transition {
+    from {
+        color: #aaa;
+    }
+    to {
+        color: #eee;
+    }
+}
+
+.actioning {
+    animation: shadow-transition 1s ease-in-out infinite alternate;
+}
+
+@keyframes shadow-transition {
+    from {
+        text-shadow: 0px 0px 10px #aaaaaa15;
+    }
+    to {
+        text-shadow: 0px 0px 10px #eee;
+    }
+}
+
+.infobox-background {
+    position: fixed; /* Stay in place */
+    z-index: 1; /* Sit on top */
+    padding-top: 100px; /* Location of the box */
+    left: 0;
+    top: 0;
+    width: 100%; /* Full width */
+    height: 100%; /* Full height */
+    overflow: auto; /* Enable scroll if needed */
+    background-color: rgb(0,0,0); /* Fallback color */
+    background-color: rgba(0,0,0,0.4); /* Black w/ opacity */
+}
+
+.infobox-content {
+    background-color: #fefefe;
+    margin: auto;
+    padding: 20px;
+    border: 1px solid #888;
+    width: 80%;
+    top: 10%;
+    z-index: 2;
+    position: fixed;
+    overflow-y: scroll;
+    max-height: 80%;
+}
+
+.infobox-close {
+    color: #aaaaaa;
+    float: right;
+    font-size: 28px;
+    font-weight: bold;
+}
+
+.infobox-close:hover, .infobox-close:focus {
+    color: #000;
+    text-decoration: none;
+    cursor: pointer;
+}
+
+.infobox-device-refresh {
+    float: right;
+    font-size: 28px;
+}
+
+#offline {
+    height: 100vh;
+    display: flex;
+    justify-content: center;
+    font-size: 48px;
+    color: white;
+}
+
+#refresh-buttons {
+    position: fixed;
+    right: 10px;
+    z-index: 1;
+}
+
+#refresh-buttons p {
+    margin-top: 0;
+}
+
+#console {
+    border: 1px solid black;
+    background-color:rgba(179, 179, 179, 0.54);
+    bottom: 0;
+    left: 0;
+    width: 40%;
+    height: 1.5em;
+    position: fixed;
+}
+
+#console.expanded {
+    height: 40%;
+}
+
+#console .top {
+    background-color: rgba(43, 43, 43, 0.397);
+    top: 0;
+    width: 100%;
+    position: absolute;
+    height: 1.5em;
+}
+
+#console .top .expanded-toggle {
+    display: block;
+    right: 1em;
+    top: -.7em;
+    position:absolute;
+}
+
+#request-list {
+    margin-top: 2em;
+}
+
+#request-list .entry {
+    border-bottom: 1px black dashed;
+}
+
+#request-list .entry em {
+    font-size: 6pt;
+    overflow-wrap: anywhere;
+    display: block;
+    opacity: 0.8;
+}
+
+#request-list .entry .elapsedTime {
+    float: right;
+    position: relative;
+    top: -2.2em;
+    right: 1em;
+    font-size: 10pt;
+    color: rgba(49, 49, 102, 0.795);
+}
+
+#request-list .entry .outgoing, #request-list .entry .incoming,  #request-list .entry .action-result {
+    font-family: 'Andale Mono', 'Courier New', Courier, monospace;
+    font-size: 9pt;
+    overflow-wrap: anywhere;
+    display: block;
+}
+
+#request-list .entry .outgoing::before {
+    content: "➡";
+}
+
+#request-list .entry .incoming::before {
+    content: "⬅";
+}
+
+#request-list .entry .action-result::before {
+    content: "✪";
+}
+
+.sched-table tr td, .sched-table tr th {
+    border: 1px solid #aaa;
+}
+
+td input.ng-invalid.ng-dirty {
+    background-color: rgb(255, 152, 152);
+}
+{%endraw%}

stinger_ipc-0.0.8/stingeripc/templates/rust/Cargo.toml.jinja2

@@ -0,0 +1,4 @@
+[workspace]
+members = ["server", "client", "payloads"]
+
+resolver = "2"

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stingeripc/templates/rust/client/Cargo.toml.jinja2

@@ -1,12 +1,11 @@
 [package]
-name = "{{stinger.name | snake_case}}_client"
+name = "{{stinger.rust.client_package_name}}"
 version = "{{stinger.version}}"
 edition = "2024"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
-connection = { path = "../connection" }
+mqttier = { git = "https://github.com/stinger-ipc/mqttier.git" }
+{{stinger.rust.common_package_name}} = { path = "../payloads" }
 futures = "0.3"
 json = "0.12.4"
 paho-mqtt = "0.13.3"
@@ -22,4 +21,7 @@ features = [
     "v4",                # Lets you generate random UUIDs
     "fast-rng",          # Use a faster (but still sufficiently random) RNG
     "macro-diagnostics", # Enable better diagnostics for compile-time UUIDs
-]
+]
+[[example]]
+name = "{{stinger.name | snake_case}}_client_demo"
+path = "examples/client.rs"

{stinger_ipc-0.0.5 → stinger_ipc-0.0.8}/stingeripc/templates/rust/client/examples/client.rs.jinja2

@@ -1,6 +1,6 @@
 use futures::{executor::block_on};
-use {{stinger.name | snake_case}}_client::{{stinger.rust.client_struct_name}};
-use connection::Connection;
+use mqttier::MqttierClient;
+use {{stinger.rust.client_package_name}}::{{stinger.rust.client_struct_name}};
 use tokio::time::{sleep, Duration};
 use tokio::join;
 
@@ -8,16 +8,17 @@ use tokio::join;
 async fn main() {
     block_on(async {
         {%set broker = stinger.get_example_broker()%}
-        let mut connection = Connection::new_{{broker.class_name|snake_case}}().await.expect("Failed to create connection");
-        let mut client = {{stinger.rust.client_struct_name}}::new(&mut connection).await;
+        let mut mqttier_client = MqttierClient::new("localhost", 1883, Some("client_example".to_string())).unwrap();
+        let {%if stinger.methods|length > 0%}mut {%endif%}api_client = {{stinger.rust.client_struct_name}}::new(&mut mqttier_client).await;
 
+        let client_for_loop = api_client.clone();
         tokio::spawn(async move {
             println!("Making call to start connection loop");
-            let _conn_loop = connection.start_loop().await;
+            let _conn_loop = client_for_loop.run_loop().await;
         });
 
         {%for sig_name, sig in stinger.signals.items()%}
-        let mut sig_rx = client.get_{{sig_name|snake_case}}_receiver();
+        let mut sig_rx = api_client.get_{{sig_name|snake_case}}_receiver();
         println!("Got signal receiver for {{sig_name}}");
 
         sleep(Duration::from_secs(5)).await;
@@ -38,16 +39,14 @@ async fn main() {
         });
         {%endfor%}
 
-        println!("Starting client receive loop");
-        let _client_loop = client.receive_loop().await;
 
         {%for method_name, method in stinger.methods.items()%}
         println!("Calling {{method_name}} with example values...");
-        let result = client.{{method_name | snake_case}}({%for arg in method.arg_list%}{{arg.get_random_example_value(lang='rust')}}{%if not loop.last%}, {%endif%}{%endfor%}).await.expect("Failed to call {{method_name}}");
+        let result = api_client.{{method_name | snake_case}}({%for arg in method.arg_list%}{{arg.get_random_example_value(lang='rust')}}{%if not loop.last%}, {%endif%}{%endfor%}).await.expect("Failed to call {{method_name}}");
         println!("{{method_name}} response: {:?}", result);
         {%endfor%}
 
-        join!(sig_rx_task);
+        let _ = join!(sig_rx_task);
     });
     // Ctrl-C to stop
 }