OpenRVDAS
6 |
7 |
25 | {% endblock %}
26 |
27 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: Bug report
3 | about: Create a report to help us improve
4 | title: ''
5 | labels: ''
6 | assignees: ''
7 |
8 | ---
9 |
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 |
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 1. Go to '...'
16 | 2. Click on '....'
17 | 3. Scroll down to '....'
18 | 4. See error
19 |
20 | **Expected behavior**
21 | A clear and concise description of what you expected to happen.
22 |
23 | **Screenshots**
24 | If applicable, add screenshots to help explain your problem.
25 |
26 | **Desktop (please complete the following information):**
27 | - OS: [e.g. iOS]
28 | - Browser [e.g. chrome, safari]
29 | - Version [e.g. 22]
30 |
31 | **Smartphone (please complete the following information):**
32 | - Device: [e.g. iPhone6]
33 | - OS: [e.g. iOS8.1]
34 | - Browser [e.g. stock browser, safari]
35 | - Version [e.g. 22]
36 |
37 | **Additional context**
38 | Add any other context about the problem here.
39 |
--------------------------------------------------------------------------------
/utils/jinja_config_creator/README.md:
--------------------------------------------------------------------------------
1 | # Configuration Generator
2 | Given a Jinja template and a yaml file of devices, generate the full cruise yaml configuration file.
3 |
4 | ## Pre-requisites:
5 |
6 | ### Jinja2
7 | Install with pip
8 |
9 | `pip install Jinja2`
10 |
11 | Documentation available at https://jinja.palletsprojects.com/
12 |
13 | ## To use Config Generator
14 |
15 | Create a Jinja template for your cruise definition file. Sample template can be found in tests directory.
16 |
17 | Create a devices.yaml file specifying the variables in your template. Sample file can be found in tests directory.
18 |
19 | Note that for each device an optional `transform_type` may be specified. Acceptable transform types include:
20 | - xml
21 | - hexstring
22 | - pyparse
23 | - (unspecified defaults to regex)
24 |
25 | Run the config generator with this command:
26 |
27 | `python cruise_config_generator.py --voyage_details test_files/sample_devices.yaml --template test_files/cruise_template.jinja --config_output test_files/sample_cruise.yaml`
28 |
29 |
--------------------------------------------------------------------------------
/contrib/utils/JSON_YAML_Creator/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "json",
3 | "version": "0.1.0",
4 | "private": true,
5 | "dependencies": {
6 | "@testing-library/jest-dom": "^4.2.4",
7 | "@testing-library/react": "^9.3.2",
8 | "@testing-library/user-event": "^7.1.2",
9 | "js-yaml": "^3.14.0",
10 | "react": "^16.13.1",
11 | "react-bootstrap": "^1.0.1",
12 | "react-copy-to-clipboard": "^5.0.2",
13 | "react-dom": "^16.13.1",
14 | "react-scripts": "3.4.1",
15 | "yaml": "^1.10.0"
16 | },
17 | "scripts": {
18 | "start": "react-scripts start",
19 | "build": "react-scripts build",
20 | "test": "react-scripts test",
21 | "eject": "react-scripts eject"
22 | },
23 | "eslintConfig": {
24 | "extends": "react-app"
25 | },
26 | "browserslist": {
27 | "production": [
28 | ">0.2%",
29 | "not dead",
30 | "not op_mini all"
31 | ],
32 | "development": [
33 | "last 1 chrome version",
34 | "last 1 firefox version",
35 | "last 1 safari version"
36 | ]
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/test/logger/utils/test_timestamp.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import sys
4 | import unittest
5 |
6 | sys.path.append('.')
7 | from logger.utils import timestamp # noqa: E402
8 |
9 |
10 | class TestTimestamp(unittest.TestCase):
11 |
12 | def test_timestamp(self):
13 | self.assertAlmostEqual(timestamp.timestamp(timestamp.time_str()),
14 | timestamp.timestamp(), places=1)
15 | self.assertEqual(timestamp.timestamp('1970-01-01T00:00:10.0Z'), 10.0)
16 |
17 | def test_time_str(self):
18 | self.assertEqual(timestamp.time_str(1507810403.33),
19 | '2017-10-12T12:13:23.330000Z')
20 | self.assertEqual(timestamp.time_str(1507810403.33, time_format='%H/%M'), '12/13')
21 |
22 | def test_date_str(self):
23 | self.assertEqual(timestamp.date_str(1507810403.33), '2017-10-12')
24 | self.assertEqual(timestamp.date_str(1507810403.33, date_format='%Y+%j'),
25 | '2017+285')
26 |
27 |
28 | if __name__ == '__main__':
29 | unittest.main()
30 |
--------------------------------------------------------------------------------
/contrib/devices/AIS.yaml:
--------------------------------------------------------------------------------
1 | ################################################################################
2 | # AIS Device Type definition
3 | #
4 | # See README.md in this directory
5 |
6 | ######################################
7 | AIS:
8 | category: "device_type"
9 | # !AIVDM,1,1,,B,15O5G4000oKPfggK2F2RQj7>0@FU,0*04
10 | format:
11 | AIVDM: "!AIVDM,{NumMessages:d},{MessageNum:d},{NextMessage:od},{Channel:ow},{Body:nc},{FillBits:d}*{Checksum:x}"
12 | AIVDO: "!AIVDO,{NumMessages:d},{MessageNum:d},{NextMessage:od},{Channel:ow},{Body:nc},{FillBits:d}*{Checksum:x}"
13 |
14 | fields:
15 | NumMessages:
16 | description: "Total number of sentences needed to transfer message"
17 | units: ""
18 | MessageNum:
19 | description: "Message sentence number"
20 | units: ""
21 | NextMessage:
22 | description: "Sequential identifier to link multiple messages"
23 | units: ""
24 | Channel:
25 | description: "AIS channel"
26 | units: ""
27 | Body:
28 | description: "Encapsulated Binary Coded Data (as per ITU-R M.1371)"
29 | units: ""
30 | FillBits:
31 | description: "Number of fill bits"
32 | units: ""
33 |
--------------------------------------------------------------------------------
/test/configs/parallel_logger.yaml:
--------------------------------------------------------------------------------
1 | # A sample file for logger/listener/listen.py
2 | ##
3 | # To run, type:
4 | #
5 | # logger/listener/listen.py --config_file test/configs/parallel_logger.yaml
6 | #
7 | # Dictionary key/value pairs are used as keyword arguments for creating a
8 | # Listener. The keys "reader", "transform" and "writer" are special-cased to
9 | # indicate that the respective entities should be instantiated (recursively,
10 | # if necessary).
11 |
12 | # We have two readers, enclosed in a list. They will be run in
13 | # parallel. The "interval" kwarg tells the TextFileReader to read one
14 | # line from its file every interval seconds.
15 | readers:
16 | - class: TextFileReader
17 | kwargs: # initialization kwargs
18 | file_spec: LICENSE
19 | interval: 1
20 | - class: TextFileReader
21 | kwargs: # initialization kwargs
22 | file_spec: README.md
23 | interval: 0.5
24 |
25 | # No transforms
26 |
27 | # Only a single writer, not enclosed in a list, to demonstrate/test
28 | # that lists are only needed if we've got multiple components.
29 | writers:
30 | class: TextFileWriter
31 | # no initialization kwargs; no filename, so write to stdout
32 |
33 |
--------------------------------------------------------------------------------
/test/logger/utils/test.crt:
--------------------------------------------------------------------------------
1 | -----BEGIN CERTIFICATE-----
2 | MIIDCjCCAfICCQD/ny7oHu8xkzANBgkqhkiG9w0BAQsFADBHMQswCQYDVQQGEwJV
3 | UzELMAkGA1UECAwCQUwxDTALBgNVBAcMBE5vbmUxDTALBgNVBAoMBE5vbmUxDTAL
4 | BgNVBAMMBHRlc3QwHhcNMjMwNTIxMDIzNjU5WhcNMjQwNTIwMDIzNjU5WjBHMQsw
5 | CQYDVQQGEwJVUzELMAkGA1UECAwCQUwxDTALBgNVBAcMBE5vbmUxDTALBgNVBAoM
6 | BE5vbmUxDTALBgNVBAMMBHRlc3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK
7 | AoIBAQC0LznAeNHnbgN7yGuj10VnKMfUBZwlG3ePV8nmuQoGSLyQQh2wG9igDftx
8 | 9uWHvt+G7Bsl0h2GP1xAWI8Hc/l/d2hHqfuVc3x++eTwjOJReEFIYr3hbTtMr07h
9 | t6os9A2jlPgPkpmdsZyuQIXlNXfS4NrGayfy3BUP095aDJTLNlldF8hWd7Q6fNUf
10 | XcTc+PyrsFpneisH5fQYXyRhxFz77ueiq2hWBP80SxIXyBETaYXJroEhx30jDnGK
11 | MZKTGDQ7ddC/dl9tDVY4bfPTldZxV6N8ES6bCG5rm1u6yE36DgGA5Q0VW9sd2G7/
12 | Wa/rFxF7LhX/E5O4F8joQbJRO+gVAgMBAAEwDQYJKoZIhvcNAQELBQADggEBALAV
13 | ijQcYUzAnKkUUure3mpqbL4nm9zjyaaSCsOKQ/eH1vlr7EYshOQqWUS+9vfJ0HEa
14 | emSf3dV132homiMfZhsMMoRXaM8oOhEQ74ycAD7z53NKp7cjw+tvsKVS2hF1cn+O
15 | lydM6y6WX2+88j785KOFYThclm3W6mtbXBV7hIq+c3lD8V50+oH44lsKGvFSMcYg
16 | UpwaxBxzkGG3RjCIpNxhLWoKsuyDFe0aQncv7mLyIiionB5UUusSB+JFv2vcdJcT
17 | /9N5CylcfdH/tJINPdz50QzFia56C8hdDYkPWHNM7XIR6XhBZdRuNEmJLk5DYIpU
18 | SBlW6EH1UutuxhfaEKw=
19 | -----END CERTIFICATE-----
20 |
--------------------------------------------------------------------------------
/logger/transforms/unique_transform.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | """Pass the record to the next transform/writer only if the contents of the
3 | record have changed from the previous value.
4 | """
5 |
6 | import sys
7 |
8 | from os.path import dirname, realpath
9 | sys.path.append(dirname(dirname(dirname(realpath(__file__)))))
10 | from logger.transforms.transform import Transform # noqa: E402
11 |
12 |
13 | ################################################################################
14 | class UniqueTransform(Transform):
15 | """Return the record only if it has changed from the previous value."""
16 |
17 | def __init__(self):
18 | """Starts with an empty record."""
19 | self.prev_record = ""
20 |
21 | ############################
22 | def transform(self, record: str):
23 |
24 | # See if it's something we can process, and if not, try digesting
25 | if not self.can_process_record(record): # inherited from Transform()
26 | return self.digest_record(record) # inherited from Transform()
27 |
28 | """If same as previous, return None, else record."""
29 | if record == self.prev_record:
30 | return None
31 |
32 | self.prev_record = record
33 |
34 | return record
35 |
--------------------------------------------------------------------------------
/contrib/config_templates/serial_reader_config_template.yaml:
--------------------------------------------------------------------------------
1 | ###################
2 | config_templates:
3 | #################
4 | serial_net_config_template: &serial_net_config_base
5 | readers:
6 | - class: SerialReader
7 | kwargs:
8 | baudrate: <
8 |
24 | Please Sign In
9 | 23 |Widget
16 | {# ######################################################################## #} 17 | 18 | {% if field_list %} 19 || waiting for first data... | 22 | {% for field_name in field_list %} 23 ||
| {{ field_name }} | 25 |- | 26 |
22 |
48 | );
49 | }
50 |
--------------------------------------------------------------------------------
/display/js/d3/LICENSE:
--------------------------------------------------------------------------------
1 | Copyright 2010-2017 Mike Bostock
2 | All rights reserved.
3 |
4 | Redistribution and use in source and binary forms, with or without modification,
5 | are permitted provided that the following conditions are met:
6 |
7 | * Redistributions of source code must retain the above copyright notice, this
8 | list of conditions and the following disclaimer.
9 |
10 | * Redistributions in binary form must reproduce the above copyright notice,
11 | this list of conditions and the following disclaimer in the documentation
12 | and/or other materials provided with the distribution.
13 |
14 | * Neither the name of the author nor the names of contributors may be used to
15 | endorse or promote products derived from this software without specific prior
16 | written permission.
17 |
18 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19 | ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
22 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25 | ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 |
--------------------------------------------------------------------------------
/database/setup_mysql_connector.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Set up appropriate user and test databases and users for mysql_connector.
4 |
5 | if [ ! $# == 2 ]; then
6 | echo Usage:
7 | echo
8 | echo $0 MYSQL_USER_NAME MYSQL_USER_PASSWORD
9 | echo
10 | echo Will create required tables and named MySQL user and give user
11 | echo access to the newly-created tables.
12 | exit
13 | fi
14 |
15 | if [ ! `which mysql` ]; then
16 | echo '####################################################################'
17 | echo NOTE: Before running this script, please install and set up
18 | echo the appropriate MySQL server.
19 | echo '####################################################################'
20 | exit
21 | fi
22 |
23 | USER=$1
24 | PWD=$2
25 |
26 | # Create databases if they don't exist, and give user access. Also
27 | # give user 'test' access to test database.
28 | #mysql -u root -p$ROOT_PWD <Kwargs
23 |
24 |
25 |
26 | {kwargs.length > 0 ? kwargs : 'Please Select a Reader'}
27 |
28 |
29 |
30 | {props.items.map((item) => (
31 | {item}
32 | ))}
33 |
34 |
35 |
36 | {' '}
46 |
47 | Choose Cruise Definition File
9 | 10 | {% if target_file %} 11 | {# ############################################################ #} 12 | {# If we have a target file, ask them to confirm loading it. #} 13 | 34 | 35 | {% else %} 36 | {# ############################################################ #} 37 | {# Directory listing here... #} 38 | 71 | {% endif %} 72 | 73 | {% endblock %} 74 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .DS_Store? 3 | #.DS_Store# 4 | 5 | pylintrc 6 | 7 | __pycache__ 8 | *.pyc 9 | 10 | *~ 11 | *.bak 12 | 13 | db.sqlite3 14 | django_gui/migrations 15 | 16 | # Files created by utils/install_openrvdas.sh 17 | django_gui/openrvdas_nginx.conf 18 | django_gui/openrvdas_uwsgi.ini 19 | django_gui/uwsgi_params 20 | 21 | # Files copied from their respective .dist sources 22 | # by utils/install_openrvdas.sh 23 | django_gui/settings.py 24 | django_gui/settings.py-e 25 | database/settings.py 26 | database/settings.py-e 27 | logger/settings.py 28 | display/js/widgets/settings.js 29 | 30 | # InfluxDB 31 | database/influxdb/LICENSE 32 | database/influxdb/README.md 33 | database/influxdb/influx 34 | database/influxdb/influxd 35 | database/influxdb/settings.py 36 | database/influxdb/settings.py-e 37 | 38 | static/ 39 | 40 | # PyCharm 41 | .idea/ 42 | 43 | # Visual Studio Code 44 | .vscode 45 | 46 | # virtualenv 47 | venv/ 48 | .venv 49 | 50 | 51 | # SSH 52 | *.pem 53 | *.crt 54 | *.key 55 | 56 | # CORIOLIX 57 | local/rcrv/settings.py 58 | local/rcrv/config_template.yaml 59 | local/rcrv/.coriolix_preferences 60 | 61 | # OceanX 62 | local/alucia 63 | 64 | # Stony Brook 65 | local/stonybrook 66 | 67 | local/unols 68 | 69 | local/usap/palmer 70 | 71 | # local for Scripps Institution of Oceanography 72 | # 73 | # SIO is testing this software out and wants the ability to make rapid 74 | # changes for a while. Once stable, we can more define what we 75 | # want to share with better granularity. 76 | local/sio/ 77 | 78 | # local for STARC (USCGC Healy) 79 | # 80 | # STARC is testing this software out and wants the ability to make rapid 81 | # changes for a while. Once stable, we can more define what we 82 | # want to share with better granularity. 83 | local/starc/ 84 | 85 | # Created by build scripts 86 | .install_influxdb_preferences 87 | .install_openrvdas_preferences 88 | .install_mysql_preferences 89 | .install_waterwall_preferences 90 | 91 | # Symlink for legacy widget paths 92 | widgets 93 | 94 | # For optional doc server 95 | mkdocs.yml 96 | 97 | # Contrib logger creation tool 98 | contrib/utils/JSON_YAML_Creator/node_modules 99 | contrib/utils/JSON_YAML_Creator/package-lock.json 100 | contrib/utils/JSON_YAML_Creator/yarn.lock 101 | 102 | # For sqlite_gui 103 | sqlite_gui 104 | .install_sqlite_gui_preferences 105 | server/openrvdas.sql 106 | 107 | # tmp 108 | tmp 109 | -------------------------------------------------------------------------------- /display/js/d3/README.md: -------------------------------------------------------------------------------- 1 | # D3: Data-Driven Documents 2 | 3 |
4 |
5 | **D3** (or **D3.js**) is a JavaScript library for visualizing data using web standards. D3 helps you bring data to life using SVG, Canvas and HTML. D3 combines powerful visualization and interaction techniques with a data-driven approach to DOM manipulation, giving you the full capabilities of modern browsers and the freedom to design the right visual interface for your data.
6 |
7 | ## Resources
8 |
9 | * [API Reference](https://github.com/d3/d3/blob/master/API.md)
10 | * [Release Notes](https://github.com/d3/d3/releases)
11 | * [Gallery](https://github.com/d3/d3/wiki/Gallery)
12 | * [Examples](https://observablehq.com/@d3)
13 | * [Wiki](https://github.com/d3/d3/wiki)
14 |
15 | ## Installing
16 |
17 | If you use npm, `npm install d3`. Otherwise, download the [latest release](https://github.com/d3/d3/releases/latest). The released bundle supports anonymous AMD, CommonJS, and vanilla environments. You can load directly from [d3js.org](https://d3js.org), [CDNJS](https://cdnjs.com/libraries/d3), or [unpkg](https://unpkg.com/d3/). For example:
18 |
19 | ```html
20 |
21 | ```
22 |
23 | For the minified version:
24 |
25 | ```html
26 |
27 | ```
28 |
29 | You can also use the standalone D3 microlibraries. For example, [d3-selection](https://github.com/d3/d3-selection):
30 |
31 | ```html
32 |
33 | ```
34 |
35 | D3 is written using [ES2015 modules](http://www.2ality.com/2014/09/es6-modules-final.html). Create a [custom bundle using Rollup](https://bl.ocks.org/mbostock/bb09af4c39c79cffcde4), Webpack, or your preferred bundler. To import D3 into an ES2015 application, either import specific symbols from specific D3 modules:
36 |
37 | ```js
38 | import {scaleLinear} from "d3-scale";
39 | ```
40 |
41 | Or import everything into a namespace (here, `d3`):
42 |
43 | ```js
44 | import * as d3 from "d3";
45 | ```
46 |
47 | In Node:
48 |
49 | ```js
50 | var d3 = require("d3");
51 | ```
52 |
53 | You can also require individual modules and combine them into a `d3` object using [Object.assign](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign):
54 |
55 | ```js
56 | var d3 = Object.assign({}, require("d3-format"), require("d3-geo"), require("d3-geo-projection"));
57 | ```
58 |
--------------------------------------------------------------------------------
/test/logger/transforms/test_to_das_record.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import logging
4 | import sys
5 | import time
6 | import unittest
7 |
8 | sys.path.append('.')
9 | from logger.transforms.to_das_record_transform import ToDASRecordTransform # noqa: E402
10 |
11 |
12 | class TestToDASRecordTransform(unittest.TestCase):
13 | ############################
14 | def test_field_name(self):
15 | t = ToDASRecordTransform(data_id='my_data_id', field_name='my_field_name')
16 | das_record = t.transform('my_value')
17 | self.assertAlmostEqual(das_record.timestamp, time.time(), delta=0.001)
18 | self.assertEqual(das_record.data_id, 'my_data_id')
19 | self.assertDictEqual(das_record.fields, {'my_field_name': 'my_value'})
20 |
21 | das_record = t.transform(['this should show up as a field value'])
22 | self.assertEqual(das_record[0].fields.get('my_field_name'),
23 | 'this should show up as a field value')
24 |
25 | ############################
26 | def test_no_field_name(self):
27 | t = ToDASRecordTransform(data_id='my_data_id')
28 | das_record = t.transform({'f1': 'v1', 'f2': 'v2'})
29 | self.assertAlmostEqual(das_record.timestamp, time.time(), delta=0.001)
30 | self.assertEqual(das_record.data_id, 'my_data_id')
31 | self.assertDictEqual(das_record.fields, {'f1': 'v1', 'f2': 'v2'})
32 |
33 | with self.assertLogs(level='WARNING'):
34 | das_record = t.transform('this should log a warning')
35 | self.assertEqual(das_record, None)
36 |
37 | with self.assertLogs(level='WARNING'):
38 | das_record = t.transform(['this should log a warning'])
39 | self.assertEqual(das_record, [])
40 |
41 |
42 | ################################################################################
43 | if __name__ == '__main__':
44 | import argparse
45 | parser = argparse.ArgumentParser()
46 | parser.add_argument('-v', '--verbosity', dest='verbosity',
47 | default=0, action='count',
48 | help='Increase output verbosity')
49 | args = parser.parse_args()
50 |
51 | LOGGING_FORMAT = '%(asctime)-15s %(filename)s:%(lineno)d %(message)s'
52 | logging.basicConfig(format=LOGGING_FORMAT)
53 |
54 | LOG_LEVELS = {0: logging.WARNING, 1: logging.INFO, 2: logging.DEBUG}
55 | args.verbosity = min(args.verbosity, max(LOG_LEVELS))
56 | logging.getLogger().setLevel(LOG_LEVELS[args.verbosity])
57 |
58 | unittest.main(warnings='ignore')
59 |
--------------------------------------------------------------------------------
/database/settings.py.dist:
--------------------------------------------------------------------------------
1 | """
2 | Settings for database operations.
3 |
4 | THIS FILE MUST BE COPIED OVER TO database/settings.py to be
5 | operational.
6 |
7 | See below for additional database-specific install requirements
8 |
9 | """
10 | # flake8: noqa E502
11 |
12 | import logging
13 | import sys
14 |
15 | sys.path.append('.')
16 |
17 | DEFAULT_DATABASE = 'data'
18 | DEFAULT_DATABASE_HOST = 'localhost'
19 | DEFAULT_DATABASE_USER = 'rvdas'
20 | DEFAULT_DATABASE_PASSWORD = 'rvdas'
21 |
22 | # Which database connector to use. When selecting a new connector, you may
23 | # need to run the corresponding database/setup_xxx_connector.sh script.
24 |
25 | Connector = None
26 | DATABASE_ENABLED = False
27 | MONGO_ENABLED = False
28 | MYSQL_ENABLED = False
29 | POSTGRES_ENABLED = False
30 |
31 | try:
32 | # Specify/uncomment the database you're using here
33 |
34 | # To set up MySQL connectivity, install, configure and start
35 | # MySQL server, and set up appropriate mysql user:
36 | # apt-get install mysql-server libmysqlclient-dev # ubuntu
37 | #
38 | # pip3 install mysqlclient, mysql-connector-python
39 | #
40 | # # Create 'data' and 'test' databases and mysql_user
41 | # database/setup_mysql_connector.sh
22 |
25 |
26 |
66 |
67 |
68 |
--------------------------------------------------------------------------------
/test/logger/transforms/test_from_json_transform.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import logging
4 | import sys
5 | import unittest
6 |
7 | sys.path.append('.')
8 | from logger.transforms.from_json_transform import FromJSONTransform # noqa: E402
9 | from logger.transforms.to_json_transform import ToJSONTransform # noqa: E402
10 | from logger.utils.das_record import DASRecord # noqa: E402
11 |
12 | sample_dict = {
13 | 'field1': 'value1',
14 | 'field2': 'value2',
15 | 'field3': 'value3',
16 | }
17 |
18 | to_str = '{"field1": "value1", "field2": "value2", "field3": "value3"}'
19 |
20 | pretty_str = """{
21 | "field1": "value1",
22 | "field2": "value2",
23 | "field3": "value3"
24 | }"""
25 |
26 |
27 | class TestFromJSONTransform(unittest.TestCase):
28 |
29 | ############################
30 | def test_both_ways(self):
31 | to_trans = ToJSONTransform()
32 | from_trans = FromJSONTransform()
33 |
34 | result = from_trans.transform(to_trans.transform(sample_dict))
35 | self.assertDictEqual(sample_dict, result)
36 |
37 | ############################
38 | def test_to(self):
39 | to_trans = ToJSONTransform()
40 | self.assertEqual(to_trans.transform(sample_dict), to_str)
41 |
42 | ############################
43 | def test_to_pretty(self):
44 | to_trans = ToJSONTransform(pretty=True)
45 | self.assertEqual(to_trans.transform(sample_dict), pretty_str)
46 |
47 | ############################
48 |
49 | def test_from(self):
50 | from_trans = FromJSONTransform()
51 | result = from_trans.transform(pretty_str)
52 | self.assertDictEqual(sample_dict, result)
53 |
54 | ############################
55 | def test_das_record_from(self):
56 | from_trans = FromJSONTransform(das_record=True)
57 | result = from_trans.transform(pretty_str)
58 | self.assertEqual(type(result), DASRecord)
59 | self.assertDictEqual(sample_dict, result.fields)
60 |
61 |
62 | ################################################################################
63 | if __name__ == '__main__':
64 | import argparse
65 | parser = argparse.ArgumentParser()
66 | parser.add_argument('-v', '--verbosity', dest='verbosity',
67 | default=0, action='count',
68 | help='Increase output verbosity')
69 | args = parser.parse_args()
70 |
71 | LOGGING_FORMAT = '%(asctime)-15s %(filename)s:%(lineno)d %(message)s'
72 | logging.basicConfig(format=LOGGING_FORMAT)
73 |
74 | LOG_LEVELS = {0: logging.WARNING, 1: logging.INFO, 2: logging.DEBUG}
75 | args.verbosity = min(args.verbosity, max(LOG_LEVELS))
76 | logging.getLogger().setLevel(LOG_LEVELS[args.verbosity])
77 |
78 | unittest.main(warnings='ignore')
79 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | # OpenRVDAS
2 | © David Pablo Cohn - david.cohn@gmail.com
3 | 2024-05-17
4 |
5 | The Open Research Vessel Data Acquisition System (OpenRVDAS) is a software framework used for building custom data acquisition systems (DAS). OpenRVDAS target audiences are oceanographic research vessel operators and operators of other science-related platforms that have the need to record streaming data. OpenRVDAS is capable of reading data records from serial ports and network-aware sensors, optionally modifying those data records and streaming either the result to one or more destinations, including logfiles, network ports, databases, etc.
6 |
7 | OpenRVDAS is designed to be modular and extensible, relying on simple composition of Readers, Transforms and Writers to achieve the needed datalogging functionality.
8 |
9 | The project code repository is at [https://github.com/oceandatatools/openrvdas](https://github.com/oceandatatools/openrvdas).
10 |
11 | ## Where to start?
12 | * [OpenRVDAS Quickstart](quickstart.md) if you want to just grab the code and poke around with basic loggers as quickly as possible.
13 | * [GUI Quickstart](quickstart_gui.md) if you want to play with the web-based interface.
14 |
15 | Other relevant documents are:
16 |
17 | * [The Listener Script - listen.py](listen_py.md) - how to use OpenRVDAS's core utility script
18 | * [Configuration Files](configuration_files.md) - how to define configuration files to simplify running loggers with listen.py
19 | * [OpenRVDAS Components](components.md) - what components exist and what they do
20 | * [Simulating Live Data](simulating_live_data.md) - using the simulate_data.py script to simulate a live system using stored data for development and testing
21 | * [Grafana/InfluxDB-based Displays](grafana_displays.md) - an introduction to using InfluxDB and Grafana for displaying data
22 | * [Parsing](parsing.md) - how to work with the included RecordParser to turn raw text records into structured data fields
23 | * [Security assumptions](security.md) - the (rather naive) security assumptions made about the environment in which OpenRVDAS runs.
24 |
25 | OpenRVDAS is a part of the [Ocean Data Tools project](http://oceandata.tools).
26 |
27 | **DISCLAIMER**: THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF
28 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
29 | WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
31 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
32 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
33 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE,
34 | INCLUDING INJURY, LOSS OF LIFE, PROPERTY, SANITY OR CREDIBILITY AMONG
35 | YOUR PEERS WHO WILL TELL YOU THAT YOU REALLY SHOULD HAVE KNOWN BETTER.
36 |
--------------------------------------------------------------------------------
/server/supervisord/supervisord.ini:
--------------------------------------------------------------------------------
1 | ; Sample supervisor config file.
2 | ;
3 |
4 | [unix_http_server]
5 | file=/opt/openrvdas/server/supervisord/supervisor.sock ; the path to the socket file
6 | chmod=0770 ; socket file mode (default 0700)
7 | chown=pablo:wheel ; socket file uid:gid owner
8 | ;username=pablo ; default is no username (open server)
9 | ;password=rvdas ; default is no password (open server)
10 |
11 | [inet_http_server] ; inet (TCP) server disabled by default
12 | port=localhost:8002 ; ip_address:port specifier, *:port for all iface
13 | ;username=pablo ; default is no username (open server)
14 | ;password=rvdas ; default is no password (open server)
15 |
16 | [supervisord]
17 | logfile=/var/log/openrvdas/supervisord.log ; main log file; default $CWD/supervisord.log
18 | stderr_logfile_maxbytes=0 ; max main logfile bytes b4 rotation; default 50MB
19 | logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB
20 | logfile_backups=10 ; # of main logfile backups; 0 means none, default 10
21 | loglevel=info ; log level; default info; others: debug,warn,trace
22 | pidfile=/usr/local/var/run/supervisord.pid ; supervisord pidfile; default supervisord.pid
23 | nodaemon=true ; start in foreground if true; default false
24 | minfds=1024 ; min. avail startup file descriptors; default 1024
25 | minprocs=200 ; min. avail process descriptors;default 200
26 | umask=022 ; process file creation umask; default 022
27 | user=pablo ; setuid to this UNIX account at startup; recommended if root
28 |
29 | ; The rpcinterface:supervisor section must remain in the config file for
30 | ; RPC (supervisorctl/web interface) to work. Additional interfaces may be
31 | ; added by defining them in separate [rpcinterface:x] sections.
32 |
33 | [rpcinterface:supervisor]
34 | supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
35 |
36 | ; The supervisorctl section configures how supervisorctl will connect to
37 | ; supervisord. configure it match the settings in either the unix_http_server
38 | ; or inet_http_server section.
39 |
40 | [supervisorctl]
41 | serverurl=unix:///opt/openrvdas/server/supervisord/supervisor.sock ; use a unix:// URL for a unix socket
42 | serverurl=http://localhost:8002 ; use an http:// url to specify an inet socket
43 | ;username=chris ; should be same as in [*_http_server] if set
44 | ;password=123 ; should be same as in [*_http_server] if set
45 | ;prompt=mysupervisor ; cmd line prompt (default "supervisor")
46 | ;history_file=~/.sc_history ; use readline history if available
47 |
48 | [include]
49 | files = /opt/openrvdas/server/supervisord/supervisor.d/*.ini
50 |
--------------------------------------------------------------------------------
/contrib/utils/JSON_YAML_Creator/src/components/JSONYAMLOutput.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 | import YAML from 'yaml';
3 | import './index.css';
4 | import { CopyToClipboard } from 'react-copy-to-clipboard';
5 |
6 | export default function YAMLOutput(props) {
7 | const divStyle = {
8 | display: 'flex',
9 | alignItems: 'center',
10 | };
11 |
12 | const combined = {
13 | readers: props.readers.map((element) => element),
14 | transforms: props.transforms.map((element) => element),
15 | writers: props.writers.map((element) => element),
16 | };
17 |
18 | return (
19 |
23 |
24 |
20 |
87 | );
88 | }
89 |
--------------------------------------------------------------------------------
/test/logger/writers/test_websocket_writer.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import logging
4 | import sys
5 | import threading
6 | import time
7 | import unittest
8 |
9 | from os.path import dirname, realpath
10 |
11 | sys.path.append('.')
12 | from logger.writers.websocket_writer import WebsocketWriter # noqa: E402
13 | from logger.readers.websocket_reader import WebsocketReader # noqa: E402
14 |
15 |
16 | class WebsocketWriterTest(unittest.TestCase):
17 |
18 | # Method to run in separate thread to run WebsocketReader
19 | def _run_writer(self, uri, records, cert_file=None, key_file=None):
20 | writer = WebsocketWriter(uri=uri, cert_file=cert_file, key_file=key_file)
21 |
22 | while not writer.client_map:
23 | time.sleep(0.1)
24 | logging.debug('writer got client')
25 |
26 | for record in records:
27 | logging.debug(f'writer writing {record}')
28 | writer.write(record)
29 | time.sleep(0.1)
30 | logging.debug('writer thread exiting')
31 |
32 | def test_read(self):
33 | uri = 'ws://localhost:8080'
34 | records = ["Hello, world!", "Goodbye, world!"]
35 | writer_thread = threading.Thread(target=self._run_writer,
36 | args=(uri, records),
37 | daemon=True)
38 | writer_thread.start()
39 |
40 | reader = WebsocketReader(uri=uri)
41 | for record in records:
42 | logging.debug(f'reader expecting {record}')
43 | received = reader.read()
44 | self.assertEqual(received, record)
45 | logging.debug(f'reader got {received}')
46 | logging.debug('reader exiting')
47 |
48 | writer_thread.join()
49 | logging.debug('writer thread joined')
50 |
51 | def test_read_ssl(self):
52 | uri = 'wss://localhost:8081'
53 | records = ["Hello, world!", "Goodbye, world!"]
54 | cert_file = dirname(dirname(realpath(__file__))) + '/utils/test.crt'
55 | key_file = dirname(dirname(realpath(__file__))) + '/utils/test.key'
56 | writer_thread = threading.Thread(target=self._run_writer,
57 | args=(uri, records, cert_file, key_file),
58 | daemon=True)
59 | writer_thread.start()
60 |
61 | reader = WebsocketReader(uri=uri)
62 | for record in records:
63 | logging.debug(f'reader expecting {record}')
64 | received = reader.read()
65 | self.assertEqual(received, record)
66 | logging.debug(f'reader got {received}')
67 | logging.debug('reader exiting')
68 |
69 | writer_thread.join()
70 | logging.debug('writer thread joined')
71 |
72 |
73 | if __name__ == "__main__":
74 | unittest.main()
75 |
--------------------------------------------------------------------------------
/logger/transforms/to_das_record_transform.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | import logging
4 | import sys
5 |
6 | from typing import Union
7 | from os.path import dirname, realpath
8 | from json import JSONDecodeError
9 |
10 | sys.path.append(dirname(dirname(dirname(realpath(__file__)))))
11 | from logger.utils.das_record import DASRecord # noqa: E402
12 | from logger.transforms.transform import Transform # noqa: E402
13 |
14 |
15 | ################################################################################
16 | #
17 | class ToDASRecordTransform(Transform):
18 | """Convert passed record to DASRecord. If record is a str, assume a
19 | JSON-encoded DASRecord. If record is a dict, use its fields as DASRecord
20 | fields. If initialized with a field_name, expect to be passed strings,
21 | and use those strings as the corresponding field values.
22 | """
23 |
24 | def __init__(self, data_id=None, field_name=None):
25 | self.data_id = data_id
26 | self.field_name = field_name
27 |
28 | ############################
29 | def transform(self, record: Union[str, dict]):
30 | """Convert record to DASRecord."""
31 |
32 | # See if it's something we can process, and if not, try digesting
33 | if not self.can_process_record(record): # inherited from Transform()
34 | return self.digest_record(record) # inherited from Transform()
35 |
36 | if isinstance(record, str):
37 | # If str, assume it's JSON unless field_name is set
38 | if self.field_name:
39 | return DASRecord(data_id=self.data_id, fields={self.field_name: record})
40 | else:
41 | try:
42 | return DASRecord(json_str=record)
43 | except JSONDecodeError:
44 | logging.warning(f'String could not be parsed as JSON DASRecord: {record}')
45 | return None
46 | # Else, if it's a dict, figure out whether it's a simple dict, or has a timestamp,
47 | # fields, etc. If not, use keys, values as fields
48 | elif isinstance(record, dict):
49 | data_id = self.data_id or record.get('data_id')
50 | timestamp = record.get('timestamp')
51 | fields = record.get('fields')
52 |
53 | # Does it have keys that mark it as a proper DASRecord already?
54 | if isinstance(fields, dict):
55 | return DASRecord(data_id=data_id, timestamp=timestamp, fields=fields)
56 |
57 | # Otherwise, assume the whole dict is a dict of fields
58 | return DASRecord(data_id=self.data_id, fields=record)
59 | else:
60 | logging.warning('ToDASRecordTransform input should be of type '
61 | f'str or dict, but received {type(record)}: {record}')
62 | return None
63 |
--------------------------------------------------------------------------------
/django_gui/templates/django_gui/change_mode.html:
--------------------------------------------------------------------------------
1 | {% extends 'django_gui/base.html' %}
2 |
3 | {% load static %}
4 |
5 | {% block content %}
6 |
7 |
20 |
21 |
22 |
23 |
24 |
21 |
49 |
22 |
48 |
23 |
33 |
24 | {JSON.stringify(
25 | combined,
26 | function (key, val) {
27 | if (key !== 'kwargClass') return val;
28 | },
29 | 2
30 | )}
31 |
32 |
34 |
44 |
45 |
46 |
47 |
50 |
86 |
51 |
85 |
52 |
66 |
53 | {YAML.stringify(
54 | JSON.parse(
55 | JSON.stringify(
56 | combined,
57 | function (key, val) {
58 | if (key !== 'kwargClass') return val;
59 | },
60 | 2
61 | )
62 | )
63 | )}
64 |
65 |
67 |
81 |
82 |
83 |
84 | Logging Mode Manager
26 || 29 | {# ################################################################## #} 30 | {# If user authenticated, allow to switch modes. Else just show mode #} 31 | 53 | | 54 |
') + '
\n'; 37 | new_log_lines += color_log_line(log_line); 38 | } 39 | 40 | // Once all log lines have been added, fetch the div where we're 41 | // going to put them, and add to bottom. 42 | if (new_log_lines.length > 0) { 43 | var target_div = document.getElementById(target_div_id); 44 | if (target_div) { 45 | target_div.innerHTML += new_log_lines; 46 | target_div.scrollTop = target_div.scrollHeight; // scroll to bottom 47 | } else { 48 | console.log('Couldn\'t find div for ' + target_div_id); 49 | } 50 | } 51 | } 52 | 53 | // Add HTML coloring to message depending on log level 54 | function color_log_line(message) { 55 | var color = ''; 56 | if (message.indexOf(' 30 WARNING ') > 0) { 57 | color = '#e09100'; 58 | } else if (message.indexOf(' 40 ERROR ') > 0) { 59 | color = 'orange'; 60 | } else if (message.indexOf(' 50 CRITICAL ') > 0) { 61 | color = 'red'; 62 | } 63 | if (color !== '') { 64 | message = '' + message + ''; 65 | } 66 | return message; 67 | } 68 | -------------------------------------------------------------------------------- /docs/secure_websockets.md: -------------------------------------------------------------------------------- 1 | # Using Secure Websockets with OpenRVDAS 2 | © 2020 David Pablo Cohn - DRAFT 2020-12-11 3 | 4 | ## Overview 5 | 6 | OpenRVDAS uses websockets to relay logger data and status information to 7 | the [CachedDataServer](cached_data_server.md), which then support 8 | display of near-realtime updates to the web console and display widgets. 9 | While on-server websocket communication is conducted (insecurely) on port 10 | 8766, in some environments security may dictate restricting off-server access 11 | to that port. For this reason, NGINX is configured to also make the cached 12 | data server available on the default web console port at path `/cds-ws`. 13 | The [OpenRVDAS installation script](../utils/install_openrvdas.sh) allows 14 | configuring NGINX to require secure websockets (`wss://`) for off-server 15 | access along this path. 16 | 17 | If, during installation, the user specifies that secure websockets should 18 | be used, they will be prompted to either specify the location of a `.crt` 19 | and `.key` certificate files, or will be coached through creation of those 20 | files via a self-signed certificate. 21 | 22 | ## Getting browsers to accept your self-signed certificate 23 | 24 | If the server already has a valid certificate, nothing more needs to be done. 25 | If the user follows the prompts to create a self-signed certificate, most browsers 26 | will balk at accepting them without a little extra work. You will need to first 27 | create a `.pem` file which, in this case, should just be a renamed copy of the 28 | public part of the certificate: 29 | 30 | ```cp my_created_certificate.crt my_created_certificate.pem``` 31 | 32 | Copy this `.pem` file to the machine on which you will be running the browser 33 | and import it into your keychain. 34 | 35 | As of 2020-12-11, on a Macintosh, you would do this as follows: 36 | 37 | 1. Open the Keychain Access app and select `File > Import Items...` 38 | 1. Navigate to the `.pem` file you've copied to your machine and import it. 39 | 1. You should now see the imported certificate under the "Certificates" 40 | header in the Keychain Access app. Double-click it and expand the `Trust` 41 | section of the new window. 42 | 1. In the "When using this certificate..." drop-down, select "Always Trust" 43 | and close the window. 44 | 1. The first time you navigate your browser to the server, you will still get 45 | a certificate warning but, if you select the "Advanced" link at the bottom 46 | of the warning (in Chrome, at least), it will give you an option to continue 47 | to the page. 48 | 49 | The method of accepting self-signed certificates will undoubtedly continue to 50 | change and make these instructions obsolete. At the very least, you can ask 51 | Google for the latest concerting your specific browser and OS: 52 | 53 | E.g.: [install certificate in chrome on macos](https://www.google.com/search?q=install+certificate+in+chrome+on+macos) 54 | -------------------------------------------------------------------------------- /logger/readers/redis_reader.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import logging 4 | import sys 5 | 6 | # Don't barf if they don't have redis installed. Only complain if 7 | # they actually try to use it, below 8 | try: 9 | import redis 10 | REDIS_ENABLED = True 11 | except ModuleNotFoundError: 12 | REDIS_ENABLED = False 13 | 14 | from os.path import dirname, realpath 15 | sys.path.append(dirname(dirname(dirname(realpath(__file__))))) 16 | from logger.readers.reader import Reader # noqa: E402 17 | from logger.utils.formats import Text # noqa: E402 18 | 19 | DEFAULT_HOST = 'localhost' 20 | DEFAULT_PORT = '6379' 21 | 22 | 23 | ################################################################################ 24 | class RedisReader(Reader): 25 | """Read messages from a redis pubsub channel.""" 26 | 27 | def __init__(self, channel, password=None): 28 | """ 29 | Read text records from a Redis pubsub server channel. 30 | ``` 31 | channel Redis channel to read from, format channel[@hostname[:port]] 32 | ``` 33 | """ 34 | super().__init__(output_format=Text) 35 | 36 | if not REDIS_ENABLED: 37 | raise ModuleNotFoundError('RedisReader(): Redis is not installed. Please ' 38 | 'try "pip3 install redis" prior to use.') 39 | self.channel = channel 40 | self.hostname = DEFAULT_HOST 41 | self.port = DEFAULT_PORT 42 | 43 | if channel.find('@') > 0: 44 | (self.channel, self.hostname) = channel.split(sep='@', maxsplit=1) 45 | if self.hostname.find(':') > 0: 46 | (self.hostname, self.port) = self.hostname.split(sep=':', maxsplit=1) 47 | self.port = int(self.port) 48 | 49 | # Connect to the specified server and subscribe to channel 50 | try: 51 | self.redis = redis.StrictRedis(host=self.hostname, port=self.port, 52 | password=password, decode_responses=True) 53 | self.pubsub = self.redis.pubsub() 54 | self.pubsub.subscribe(self.channel) 55 | except redis.exceptions.ConnectionError as e: 56 | logging.error('Unable to connect to server at %s:%d', 57 | self.hostname, self.port) 58 | raise e 59 | 60 | ############################ 61 | def read(self): 62 | """Read/wait for message from pubsub channel.""" 63 | 64 | while True: 65 | message = next(iter(self.pubsub.listen())) 66 | logging.debug('Got message "%s"', message) 67 | if message.get('type') == 'message': 68 | data = message.get('data') 69 | if data: 70 | return data 71 | 72 | # Alternatively, we could use 73 | # while True: 74 | # message = self.pubsub.get_message(timeout=10) 75 | # if message: 76 | # record = message.get('data') 77 | # if record: 78 | # return record 79 | -------------------------------------------------------------------------------- /display/js/highcharts/code/modules/solid-gauge.js: -------------------------------------------------------------------------------- 1 | /* 2 | Highcharts JS v6.1.1 (2018-06-27) 3 | Solid angular gauge module 4 | 5 | (c) 2010-2017 Torstein Honsi 6 | 7 | License: www.highcharts.com/license 8 | */ 9 | (function(l){"object"===typeof module&&module.exports?module.exports=l:l(Highcharts)})(function(l){(function(e){var l=e.pInt,u=e.pick,m=e.each,r=e.isNumber,w=e.wrap,v;w(e.Renderer.prototype.symbols,"arc",function(a,f,d,c,e,b){a=a(f,d,c,e,b);b.rounded&&(c=((b.r||c)-b.innerR)/2,b=["A",c,c,0,1,1,a[12],a[13]],a.splice.apply(a,[a.length-1,0].concat(["A",c,c,0,1,1,a[1],a[2]])),a.splice.apply(a,[11,3].concat(b)));return a});v={initDataClasses:function(a){var f=this.chart,d,c=0,t=this.options;this.dataClasses= 10 | d=[];m(a.dataClasses,function(b,h){b=e.merge(b);d.push(b);b.color||("category"===t.dataClassColor?(h=f.options.colors,b.color=h[c++],c===h.length&&(c=0)):b.color=e.color(t.minColor).tweenTo(e.color(t.maxColor),h/(a.dataClasses.length-1)))})},initStops:function(a){this.stops=a.stops||[[0,this.options.minColor],[1,this.options.maxColor]];m(this.stops,function(a){a.color=e.color(a[1])})},toColor:function(a,f){var d=this.stops,c,e,b=this.dataClasses,h,g;if(b)for(g=b.length;g--;){if(h=b[g],c=h.from,d= 11 | h.to,(void 0===c||a>=c)&&(void 0===d||a<=d)){e=h.color;f&&(f.dataClass=g);break}}else{this.isLog&&(a=this.val2lin(a));a=1-(this.max-a)/(this.max-this.min);for(g=d.length;g--&&!(a>d[g][0]););c=d[g]||d[g+1];d=d[g+1]||c;a=1-(d[0]-a)/(d[0]-c[0]||1);e=c.color.tweenTo(d.color,a)}return e}};e.seriesType("solidgauge","gauge",{colorByPoint:!0},{translate:function(){var a=this.yAxis;e.extend(a,v);!a.dataClasses&&a.options.dataClasses&&a.initDataClasses(a.options);a.initStops(a.options);e.seriesTypes.gauge.prototype.translate.call(this)}, 12 | drawPoints:function(){var a=this,f=a.yAxis,d=f.center,c=a.options,t=a.chart.renderer,b=c.overshoot,h=r(b)?b/180*Math.PI:0,g;r(c.threshold)&&(g=f.startAngleRad+f.translate(c.threshold,null,null,null,!0));this.thresholdAngleRad=u(g,f.startAngleRad);m(a.points,function(b){var g=b.graphic,k=f.startAngleRad+f.translate(b.y,null,null,null,!0),m=l(u(b.options.radius,c.radius,100))*d[2]/200,n=l(u(b.options.innerRadius,c.innerRadius,60))*d[2]/200,p=f.toColor(b.y,b),q=Math.min(f.startAngleRad,f.endAngleRad), 13 | r=Math.max(f.startAngleRad,f.endAngleRad);"none"===p&&(p=b.color||a.color||"none");"none"!==p&&(b.color=p);k=Math.max(q-h,Math.min(r+h,k));!1===c.wrap&&(k=Math.max(q,Math.min(r,k)));q=Math.min(k,a.thresholdAngleRad);k=Math.max(k,a.thresholdAngleRad);k-q>2*Math.PI&&(k=q+2*Math.PI);b.shapeArgs=n={x:d[0],y:d[1],r:m,innerR:n,start:q,end:k,rounded:c.rounded};b.startR=m;g?(b=n.d,g.animate(e.extend({fill:p},n)),b&&(n.d=b)):(b.graphic=t.arc(n).addClass(b.getClassName(),!0).attr({fill:p,"sweep-flag":0}).add(a.group), 14 | "square"!==c.linecap&&b.graphic.attr({"stroke-linecap":"round","stroke-linejoin":"round"}),b.graphic.attr({stroke:c.borderColor||"none","stroke-width":c.borderWidth||0}))})},animate:function(a){a||(this.startAngleRad=this.thresholdAngleRad,e.seriesTypes.pie.prototype.animate.call(this,a))}})})(l)}); 15 | -------------------------------------------------------------------------------- /logger/writers/redis_writer.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import logging 4 | import sys 5 | 6 | # Don't barf if they don't have redis installed. Only complain if 7 | # they actually try to use it, below 8 | try: 9 | import redis 10 | REDIS_ENABLED = True 11 | except ModuleNotFoundError: 12 | REDIS_ENABLED = False 13 | 14 | from os.path import dirname, realpath 15 | sys.path.append(dirname(dirname(dirname(realpath(__file__))))) 16 | from logger.writers.writer import Writer # noqa: E402 17 | 18 | DEFAULT_HOST = 'localhost' 19 | DEFAULT_PORT = '6379' 20 | 21 | 22 | class RedisWriter(Writer): 23 | """Write to redis server pubsub channel.""" 24 | 25 | def __init__(self, channel, password=None): 26 | """ 27 | Write text records to a Redis pubsub server channel. 28 | ``` 29 | channel Redis channel to write to, format channel[@hostname[:port]] 30 | ``` 31 | """ 32 | if not REDIS_ENABLED: 33 | raise ModuleNotFoundError('RedisReader(): Redis is not installed. Please ' 34 | 'try "pip3 install redis" prior to use.') 35 | self.channel = channel 36 | self.hostname = DEFAULT_HOST 37 | self.port = DEFAULT_PORT 38 | 39 | if channel.find('@') > 0: 40 | (self.channel, self.hostname) = channel.split(sep='@', maxsplit=1) 41 | if self.hostname.find(':') > 0: 42 | (self.hostname, self.port) = self.hostname.split(sep=':', maxsplit=1) 43 | self.port = int(self.port) 44 | 45 | # Connect to the specified server 46 | try: 47 | self.redis = redis.StrictRedis(host=self.hostname, port=self.port, 48 | password=password, decode_responses=True) 49 | self.redis.ping() 50 | self.pubsub = self.redis.pubsub() 51 | except redis.exceptions.ConnectionError as e: 52 | logging.error('Unable to connect to server at %s:%d', 53 | self.hostname, self.port) 54 | raise e 55 | 56 | ############################ 57 | def write(self, record): 58 | """Write the record to the pubsub channel.""" 59 | 60 | # See if it's something we can process, and if not, try digesting 61 | if not self.can_process_record(record): # inherited from BaseModule() 62 | self.digest_record(record) # inherited from BaseModule() 63 | return 64 | 65 | # If record is not a string, try converting to JSON. If we don't know 66 | # how, throw a hail Mary and force it into str format 67 | # if not type(record) is str: 68 | # if type(record) in [int, float, bool, list, dict]: 69 | # record = json.dumps(record) 70 | # else: 71 | # record = str(record) 72 | 73 | try: 74 | self.redis.publish(self.channel, record) 75 | except redis.exceptions.ConnectionError as e: 76 | logging.error('Unable to connect to server at %s:%d', 77 | self.hostname, self.port) 78 | raise e 79 | -------------------------------------------------------------------------------- /test/logger/transforms/test_nmea_transform.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # flake8: noqa E501 - ignore long lines 4 | 5 | import json 6 | import logging 7 | import pprint 8 | import sys 9 | import tempfile 10 | import time 11 | import unittest 12 | import warnings 13 | 14 | sys.path.append('.') 15 | from logger.transforms.nmea_transform import NMEATransform 16 | 17 | 18 | class TestNMEATransform(unittest.TestCase): 19 | # set to None to see full diff for long results 20 | maxDiff = None 21 | 22 | test_records = [ 23 | ({'data_id': 'ship_nav', 'timestamp': 1708644853.370747, 24 | 'fields': {'Latitude': 4404.67098, 25 | 'Longitude': 11500.0019, 26 | 'CourseTrue': 1.1, 27 | 'SpeedOverGround': 8.1, 28 | 'HeadingTrue': 355.0, 29 | 'SurfaceCourse': 355.0, 30 | 'SurfaceSpeed': 7.861768248937385, 31 | 'DriftCourse': 72.40182954879155, 32 | 'DriftSpeed': 0.8819736152620004, 33 | 'Roll': 0.08, 34 | 'Pitch': 0.65, 35 | 'Heave': -0.03, 36 | 'DepthBelowTransducer': 4279.79, 37 | 'OffsetTransducer': 7.33, 38 | 'PositionSource': 'posmv'}}, 39 | ['$GPSTN,posmv*05', '$GPDPT,4279.79,7.33*66']) 40 | 41 | ] 42 | 43 | ############################ 44 | def test_nmea_transform(self): 45 | t = NMEATransform(nmea_list=['STNTransform', 'DPTTransform'], 46 | stn_talker_id='GPSTN', id_field='PositionSource', 47 | dpt_talker_id='GPDPT', depth_field='DepthBelowTransducer', offset_field='OffsetTransducer') 48 | 49 | for j, (line, expected) in enumerate(self.test_records): 50 | result = t.transform(line) 51 | logging.info('expected: %s, result: %s', expected, result) 52 | self.assertEqual(expected, result) 53 | 54 | def test_bad_nmea_list(self): 55 | with self.assertLogs(logging.getLogger(), level='INFO') as cm: 56 | t = NMEATransform(nmea_list=['BADTransform']) 57 | # Check that the first log message in the output is the one we want 58 | self.assertIn('BADTransform is not in classes', cm.output[0]) 59 | 60 | 61 | ################################################################################ 62 | if __name__ == '__main__': 63 | import argparse 64 | 65 | parser = argparse.ArgumentParser() 66 | parser.add_argument('-v', '--verbosity', dest='verbosity', 67 | default=0, action='count', 68 | help='Increase output verbosity') 69 | args = parser.parse_args() 70 | 71 | LOGGING_FORMAT = '%(asctime)-15s %(filename)s:%(lineno)d %(message)s' 72 | logging.basicConfig(format=LOGGING_FORMAT) 73 | 74 | LOG_LEVELS = {0: logging.WARNING, 1: logging.INFO, 2: logging.DEBUG} 75 | args.verbosity = min(args.verbosity, max(LOG_LEVELS)) 76 | logging.getLogger().setLevel(LOG_LEVELS[args.verbosity]) 77 | 78 | unittest.main(warnings='ignore') --------------------------------------------------------------------------------