finometer-logger


Namefinometer-logger JSON
Version 0.1.0 PyPI version JSON
download
home_page
SummaryA logger that logs finometer data from a serial input.
upload_time2023-06-25 13:18:03
maintainer
docs_urlNone
authorAlex
requires_python>=3.10,<3.12
licenseGPL-v3-or-above
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Finometer Logger

## Installation

- Clone this repository with:

``` sh
git clone git@gitlab.com:abdrysdale/finometer-logger.git
```

- Change into the `finometer-logger` directory.
- Install the dependencies either with:

``` sh
poetry install
poetry shell
```

or by manually installing using your preferred method. The installation dependencies are only:
    - `serialdatalog`
    - `numpy`
    - `plotly`
    - `dash`
    - `dash_daq`
    - `toml`

## Usage

The main python script is in `finometer_logger/finometer.py` and to run, simple use:

``` sh
poetry run python finometer_logger/finometer.py
```

or 

``` sh
python finometer_logger/finometer.py
```

By default, the script continously gathers data from the [serialdatalog](https://gitlab.com/abdrysdale/serial-data-logger) database in a background thread whilst plotting the results every 1s in plotly Dash app.

The webapp can be accessed on https://127.0.0.1:8050 and will display the live results of the data logger.

To start collecting data, click the switch above the graph.

To stop collecting data, click the switch again, the data is automatically saved to a csv file with the name as the timestamp the data collection was started - e.g. `t20230530090056.csv` if data collection was started on `30/05/2023 09:00:56`.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "finometer-logger",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "",
    "author": "Alex",
    "author_email": "adrysdale@protonmail.com",
    "download_url": "https://files.pythonhosted.org/packages/2f/fb/c0ce8674501a9b1d93e0c4536434874c3548c6edb5ff28f783ae0de62fa4/finometer_logger-0.1.0.tar.gz",
    "platform": null,
    "description": "# Finometer Logger\n\n## Installation\n\n- Clone this repository with:\n\n``` sh\ngit clone git@gitlab.com:abdrysdale/finometer-logger.git\n```\n\n- Change into the `finometer-logger` directory.\n- Install the dependencies either with:\n\n``` sh\npoetry install\npoetry shell\n```\n\nor by manually installing using your preferred method. The installation dependencies are only:\n    - `serialdatalog`\n    - `numpy`\n    - `plotly`\n    - `dash`\n    - `dash_daq`\n    - `toml`\n\n## Usage\n\nThe main python script is in `finometer_logger/finometer.py` and to run, simple use:\n\n``` sh\npoetry run python finometer_logger/finometer.py\n```\n\nor \n\n``` sh\npython finometer_logger/finometer.py\n```\n\nBy default, the script continously gathers data from the [serialdatalog](https://gitlab.com/abdrysdale/serial-data-logger) database in a background thread whilst plotting the results every 1s in plotly Dash app.\n\nThe webapp can be accessed on https://127.0.0.1:8050 and will display the live results of the data logger.\n\nTo start collecting data, click the switch above the graph.\n\nTo stop collecting data, click the switch again, the data is automatically saved to a csv file with the name as the timestamp the data collection was started - e.g. `t20230530090056.csv` if data collection was started on `30/05/2023 09:00:56`.\n",
    "bugtrack_url": null,
    "license": "GPL-v3-or-above",
    "summary": "A logger that logs finometer data from a serial input.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "85a0e427106d358cf5c4719ad9558e65775da30b539612b1a1643a16558279b3",
                "md5": "04d7327f85150471eb9c298e8d6f454f",
                "sha256": "ba09e84dbf991e45c084236409fee84f9f6e0c3489232e182852829c3c86978f"
            },
            "downloads": -1,
            "filename": "finometer_logger-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "04d7327f85150471eb9c298e8d6f454f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 4026,
            "upload_time": "2023-06-25T13:18:01",
            "upload_time_iso_8601": "2023-06-25T13:18:01.418712Z",
            "url": "https://files.pythonhosted.org/packages/85/a0/e427106d358cf5c4719ad9558e65775da30b539612b1a1643a16558279b3/finometer_logger-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ffbc0ce8674501a9b1d93e0c4536434874c3548c6edb5ff28f783ae0de62fa4",
                "md5": "7a6a4e1b43ea5d69b3d470f22f4e2db1",
                "sha256": "8da1bbbc38d80fd0c2a1b1b5c62e2bed74e9d484e2b93864ccc9649de37d3fdf"
            },
            "downloads": -1,
            "filename": "finometer_logger-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7a6a4e1b43ea5d69b3d470f22f4e2db1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 3664,
            "upload_time": "2023-06-25T13:18:03",
            "upload_time_iso_8601": "2023-06-25T13:18:03.380105Z",
            "url": "https://files.pythonhosted.org/packages/2f/fb/c0ce8674501a9b1d93e0c4536434874c3548c6edb5ff28f783ae0de62fa4/finometer_logger-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-25 13:18:03",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "finometer-logger"
}
        
Elapsed time: 0.12100s