Fixed Parameter (ServiceInfo)

.gitignore

@@ -136,3 +136,5 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+/rfc2217-gateway-env/*
+/tmp/

README.md

@@ -1,19 +1,49 @@
 ## Introduction
 
-Gateway that shares different USB sticks through RFC2217.
+Gateway that shares different USB sticks and SARAD instruments with integrated
+FT232R serial to USB converter through RFC2217.
 
 ## Features
 
 The program has the following features:
 
-- Detects plugged and unplugged USB sticks (udev)
+- Detects plugged and unplugged USB sticks and SARAD instruments (udev)
 - Shares the USB stick serial connection through RFC2217
 - Announces the RFC2217 connection to the rest of the network (mDNS)
 
+## Installation and usage
+
+For test and development, the program is prepared to run in a virtual environment.
+
+### Installation ###
+
+    git clone <bare_repository>
+
+to clone the working directory from the git repository.
+
+    cd src-instrumentserver2-rfc2217
+    bin/env-create
+
+to create the directory with the virtual environment.
+
+    bin/activate
+
+to activate the virtual environment.
+
+### Usage ###
+
+    bin/rfc2217-gateway
+
+to start the program.
+
+After attaching a SARAD instrument you should see log messages indicating that a
+device was detected and connected to a port.
+
 ## Author
 
 (c) 2020 [Aitor Iturrioz](https://github.com/bodiroga)
 
+## License
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
@@ -24,4 +54,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

bin/.gitattributes

@@ -0,0 +1 @@
+*		text eol=lf

bin/activate

@@ -0,0 +1,9 @@
+#!/bin/bash
+SOURCE="${BASH_SOURCE[0]}"
+#echo $SOURCE
+SOURCE_DIR=$(dirname $SOURCE)
+#echo $SOURCE_DIR
+CURENT_DIR=$PWD
+cd $SOURCE_DIR/../
+source rfc2217-gateway-env/bin/activate
+cd $CURRENT_DIR

bin/activate.ps1

@@ -0,0 +1 @@
+rfc2217-gateway-env/bin/activate.ps1

bin/env-create

@@ -0,0 +1,13 @@
+#!/bin/bash
+SOURCE="${BASH_SOURCE[0]}"
+#echo $SOURCE
+SOURCE_DIR=$(dirname $SOURCE)
+#echo $SOURCE_DIR
+CURENT_DIR=$PWD
+cd $SOURCE_DIR/../
+#echo $PWD
+python -m venv rfc2217-gateway-env
+source rfc2217-gateway-env/bin/activate
+rfc2217-gateway-env/bin/pip install --requirement=requirements.txt
+rfc2217-gateway-env/bin/pip install -e git+https://www.github.com/SARAD-GmbH/data_collector#egg=data_collector
+cd $CURRENT_DIR

bin/rfc2217-gateway

@@ -0,0 +1,10 @@
+#!/bin/bash
+SOURCE="${BASH_SOURCE[0]}"
+#echo $SOURCE
+SOURCE_DIR=$(dirname $SOURCE)
+#echo $SOURCE_DIR
+CURENT_DIR=$PWD
+cd $SOURCE_DIR/../
+source rfc2217-gateway-env/bin/activate
+rfc2217-gateway-env/bin/python3 src/main.py
+cd $CURRENT_DIR

bin/update

@@ -0,0 +1,11 @@
+#!/bin/bash
+SOURCE="${BASH_SOURCE[0]}"
+#echo $SOURCE
+SOURCE_DIR=$(dirname $SOURCE)
+#echo $SOURCE_DIR
+CURENT_DIR=$PWD
+cd $SOURCE_DIR/../
+source rfc2217-gateway-env/bin/activate
+rfc2217-gateway-env/bin/pip install --requirement=requirements.txt
+rfc2217-gateway-env/bin/pip install -e git+https://github.com/SARAD-GmbH/data_collector#egg=data_collector
+cd $CURRENT_DIR

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: c843f108fa3bf006a304898911b021dd
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/build/html/_sources/index.rst.txt

@@ -0,0 +1,27 @@
+.. instrumentserver2 documentation master file, created by
+   sphinx-quickstart on Wed Feb 10 17:55:28 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to instrumentserver2's documentation!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+mdns_advertiser
+===============
+
+.. automodule:: mdns_advertiser
+   :members:
+   :undoc-members:
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`