mx-remote 2.0.0__tar.gz

mx_remote-2.0.0/.gitignore

@@ -0,0 +1,4 @@
+__pycache__
+/build
+/dist
+*.egg-info

mx_remote-2.0.0/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2024 Lars Op den Kamp <lars@opdenkamp.eu>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mx_remote-2.0.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.3
+Name: mx_remote
+Version: 2.0.0
+Summary: Python 3 library for interfacing with MX Remote compatible devices
+Project-URL: Homepage, https://github.com/opdenkamp/mx-remote/
+Project-URL: Documentation, https://github.com/opdenkamp/mx-remote/
+Project-URL: Repository, https://github.com/opdenkamp/mx-remote.git
+Project-URL: Bug Tracker, https://github.com/opdenkamp/mx-remote/issues
+Author-email: Lars Op den Kamp <lars@opdenkamp.eu>
+Maintainer-email: Lars Op den Kamp <lars@opdenkamp.eu>
+License: Copyright 2024 Lars Op den Kamp <lars@opdenkamp.eu>
+        
+        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Keywords: ampos,matrixos,oneip,pulse-eight
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python
+Classifier: Topic :: System :: Networking :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: aiofiles>=24.1.0
+Requires-Dist: aiohttp>=3.10.5
+Requires-Dist: argparse>=1.4.0
+Requires-Dist: netifaces>=0.11.0
+Description-Content-Type: text/markdown
+
+# MX Remote Interface
+
+Python 3 library for interfacing with MX Remote compatible devices.
+
+## Installation
+
+Run `pip install .`
+
+## Documentation
+
+Documentation is embedded in the Python code, which is automatically used by most common IDEs.
+
+You can also use Python to read the documentation:
+```python
+import mx_remote
+help(mx_remote.Interface)
+exit()
+```
+
+## Developers
+
+Bare minimum application that runs `mx_remote`:
+```python
+import asyncio
+import mx_remote
+
+loop = asyncio.get_event_loop()
+mx = mx_remote.Remote()
+loop.run_until_complete(mx.start_async())
+loop.run_forever()
+```
+
+## Application
+The console application is started by running `mxr`.
+
+The application also includes methods for debugging MX Remote networks:
+* The console application will always dump all received frames in human readable form on the console
+* To dump these frames in a file `mxr -u 1 -o /path/to/file.txt`
+* Import frames captured by MatrixOS and dump the frames: `mxr -i /path/to/file.bin`
+
+All command line options:
+```
+usage: mxr [-h] [-i INPUT] [-f FILTER] [-o OUTPUT] [-l LOCAL_IP] [-b BROADCAST] [-u UI]
+
+MX Remote Manager / Debugger
+
+options:
+  -h, --help    show this help message and exit
+  -i INPUT      capture file to process
+  -f FILTER     ip address to process in the capture file
+  -o OUTPUT     write output to a file
+  -l LOCAL_IP   local ip address of the network interface to use
+  -b BROADCAST  use broadcast mode instead of multicast mode
+  -u UI         show the user interface
+```
+
+The user interface option and `mxr-ui` application are only available when `mx_remote_manager` is installed after installing `mx_remote`.
+Plain `mx_remote` only includes the command line version of `mxr`.

mx_remote-2.0.0/README.md

@@ -0,0 +1,58 @@
+# MX Remote Interface
+
+Python 3 library for interfacing with MX Remote compatible devices.
+
+## Installation
+
+Run `pip install .`
+
+## Documentation
+
+Documentation is embedded in the Python code, which is automatically used by most common IDEs.
+
+You can also use Python to read the documentation:
+```python
+import mx_remote
+help(mx_remote.Interface)
+exit()
+```
+
+## Developers
+
+Bare minimum application that runs `mx_remote`:
+```python
+import asyncio
+import mx_remote
+
+loop = asyncio.get_event_loop()
+mx = mx_remote.Remote()
+loop.run_until_complete(mx.start_async())
+loop.run_forever()
+```
+
+## Application
+The console application is started by running `mxr`.
+
+The application also includes methods for debugging MX Remote networks:
+* The console application will always dump all received frames in human readable form on the console
+* To dump these frames in a file `mxr -u 1 -o /path/to/file.txt`
+* Import frames captured by MatrixOS and dump the frames: `mxr -i /path/to/file.bin`
+
+All command line options:
+```
+usage: mxr [-h] [-i INPUT] [-f FILTER] [-o OUTPUT] [-l LOCAL_IP] [-b BROADCAST] [-u UI]
+
+MX Remote Manager / Debugger
+
+options:
+  -h, --help    show this help message and exit
+  -i INPUT      capture file to process
+  -f FILTER     ip address to process in the capture file
+  -o OUTPUT     write output to a file
+  -l LOCAL_IP   local ip address of the network interface to use
+  -b BROADCAST  use broadcast mode instead of multicast mode
+  -u UI         show the user interface
+```
+
+The user interface option and `mxr-ui` application are only available when `mx_remote_manager` is installed after installing `mx_remote`.
+Plain `mx_remote` only includes the command line version of `mxr`.