PubInv / PIRDS-docker-local

Docker file and environment for doing local logging of PIRDS data and VentDisplay rendering

Introduction

This repo allows you to build a docker image file which, when running, supports both interactive and long-term logging of Public Invention Respiration Data Standard (PIRDS) data.

This is part of a Public Invention Respiration ecosystem, and requires some understanding of that system, though it is designed to be usable as a completely independent component.

However, the most obvious use of this repo is to make a local, possibly long-term, data log of respiraiton data produced by the VentMon Inline Tester-Monitor, possibly because you are evaluating a mechanical ventilation device. The easiest way to use that device is to use the Public Invention public data lake at ventmon.coslabs.com, where data is logged if you enable the Ethernet or WiFi features of the VentMon T0.4. Although you can figure all the components in this docker image separately, our hope is that this makes configuration simpler for those who main want data log files.

The System

The image below roughly depicts how a running system works.

Usage

This repo creates a Docker image file. You will want to install Docker. In theory, this will allow you to run the result image on a Windows machine, as well as a GNU/Linux or a Mac.

You probably don't want to use this unless use are running serialserver.js for the purpose of transmitting PIRDS data on a serial port to a PIRDS logger listening to UDP. (In this case, the PIRDS logger will be running inside your Docker image.)

serialerver.js can be found in the VentDisplay repo.

docker build --tag pirds-logger .

docker run -d --name logger -p 8081:80 -p 6111:6111/udp -v `pwd`/logger_src/data:/data pirds-logger

Basic usage is:

1. Build the docker image from this repo and start it from the repo. This location should have a directory sub-structure: logger_src/data, which will be where the log files will be found when you are done. On a GNU/Linux system or a Mac, `wd` will expand to the absolute path where you are (this repo). On a Windows machine, you may have to enter a full path there instead.
2. Plug in a PIRDS generating devices on the serial port (either VentMon or a VentOS device.)
3. Start the serialserver.js program found else where, point it at the local instance of the UDP port 6111 (matching above). You will have to know the name of your serial port!
4. Point a browser at localhost:8081 to see a list of data files. The link at the top will take you to VentDisplay rendering live data from your PIRDS-producing device.
5. When you stop the docker image (or before, really), in logger_src/data you will find the a file named something like: 0Logfile.172.17.0.1 If you have two dockder images running, the name could be slightly different. This is a log file from your run contaning the entire (possibly multi-day log). You may wish to copy this to a convenient area.

The PIRDS log file is fully documented. It is our intention to make a long term analysis program that can analyze weeks of data. However, this has not yet been written.

A Note on Freshness

In order to make docker images, all of the sources files from three repos PIRDS library, PIRDS logger, and VentDisplay are copied here. This means that this image is likely to be stable and usable. However, those repos are all under active development; there may be features there which are not necessarily reflected in this repo.