Skip to content

Commit c7ae51a

Browse files
CharlesGodwinCharlesGodwin
authored
Pre release 2.0 (#35)
* Tentative release * Fixed order of import serial * Small typos and added MAGNUM_DELAY documentation * Fixup in CHANGES * Added version parameter * Fixed multiplier last pre-release * cleanup * cleanup 2 * cleanup some documentation * Tentative version * Added support for log file packets * Ammended documentation * Version 2.0rc6 and cleaned up documentation * moved utility * added missing BUILDINFO tag * Small cleanup pre-release * Release 2.0 * Cleanup * Cleaned up messages
1 parent 75cbaf3 commit c7ae51a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+2328
-1739
lines changed

‎.gitignore

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
.vscode
22
magnum/.vscode
3-
magnum/tools/__pycache__
3+
magnum/tools
44
magnum/__pycache__
55
__pycache__
6-
build
7-
dist
6+
build/**
7+
docs/_build
8+
dist/**
89
install.log
910
magnum.egg-info
1011
pymagnum.egg-info
@@ -15,3 +16,6 @@ source/_build
1516
docs/_build
1617
testdata
1718
.pymodhis
19+
logs/**
20+
./pymagnum.opt
21+
publish_doc.ps1

‎CHANGES.rst

+29-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,44 @@
1-
========================
1+
=======================
22
pyMagnum Release Notes
3-
========================
3+
=======================
4+
5+
Version 2.0 2022/06/06
6+
---------------------
7+
- Added: The ability to define all options in a configuration file. For example ``magdump @pymagnum.opt``. See documentation.
8+
- Added: ``magdump`` and examples programs support use of configuration file.
9+
- Added: A new method ``getComm_Device()`` in the Magnum class to retrieve name of device.
10+
- Added: 30 second delay from boot time issue #16
11+
- Added: documentation of fields
12+
- Enhanced: The utility tool ``magdump`` now supports defining more that one device. See documentation. **NOTE** ``magtest`` does NOT support multiple devices.
13+
- Enhanced: The example programs have been enhanced to support multiple devices.
14+
- Enhanced: The utility tool ``magtest`` now supports writing a copy of the displayed messages to a log file. ``--log``
15+
- Enhanced: ``magtest``
16+
- Enhanced: Normalized fields and field types
17+
- Many Integer fields have become Float
18+
- Some fields have been dropped
19+
- Revised: PT-100 processing issue #15
20+
(refer to Installation in documentation)
21+
- Fixed: Bug in battery size calculation - now using BMK value
22+
- Fixed: Source code was refactored to simplify coding
23+
- each device class was moved to an individual file
24+
- the tools subdirectory was collapsed into the main directory
25+
- Fixed: The voltage multiplier was not being handled correctly. Some values were being generated as if you have a 12VDC system when voltage of system was 24VDC or 48VDC.
26+
427
Version 1.1.3 2020/07/12
5-
-----------------------
28+
--------------------------
629
- Fixed issue #13 leaving port open when no network detected
730

831
Version 1.1.2 2020/06/17
9-
------------------------
32+
--------------------------
1033
- Fixed error in 'running' status for AGS device
1134

1235
Version 1.1.1.post1 2020/06/11
13-
------------------------
36+
------------------------------
1437
- Improved PT-100 processing
1538
- Added support for older (classic) Inverter and Remote issue #10
1639
- Revised documentation to indicate support for only MS series inverters and ME-RC, ME-ARC, ME-RTR and ME-ARTR remotes
1740
- Added how to build instructions
18-
- Removed reference to duplicates in examples/mqttlogger.py
41+
- Removed reference to duplicates in examples/mqttlogger.py
1942

2043
Version 1.1 2019/12/08
2144
---------------------------

‎How the Magnum Energy Network Works.docx

26.4 KB
Binary file not shown.

‎README.rst

+32-22
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
1-
pyMagnum
2-
========
3-
4-
pyMagnum is a Python 3 implementation of a read only interface to the
5-
Magnum Energy network.
6-
7-
`The Python package site <https://pypi.org/project/pymagnum/>`_
8-
9-
This software is not endorsed or supported by Magnum Energy, a product
10-
of Sensata Technologies https://www.magnum-dimensions.com/
11-
12-
Please read the documentation before installing this package.
13-
Some operating systems, including Raspberry Pi OS,
14-
require you to use ``python3`` and ``pip3`` to use the Python 3 version of these tools.
15-
16-
`Documentation <https://pymagnum.readthedocs.io/>`_
17-
18-
`Changes <https://github.com/CharlesGodwin/pymagnum/blob/master/CHANGES.rst>`_
19-
20-
Copyright (c) 2018-2020 Charles Godwin [email protected]
21-
22-
SPDX-License-Identifier: BSD-3-Clause
1+
pyMagnum
2+
========
3+
4+
pyMagnum is a Python implementation of a read only interface to the
5+
Magnum Energy network.
6+
7+
`The Python package site <https://pypi.org/project/pymagnum/>`_
8+
9+
This software is not endorsed or supported by Magnum Energy, a product
10+
of Sensata Technologies https://www.magnum-dimensions.com/
11+
12+
Please read the documentation before installing this package.
13+
Older versions of some operating systems, require you to use ``python3`` and ``pip3`` to use the Python 3 version of these tools.
14+
15+
If you have installed version 1.1.3 and it is working, there is no reason to upgrade to this version. The fundamental software is unchanged, although there ar a few enhancements to functionality.
16+
17+
.. BUILDINFO
18+
19+
production
20+
21+
`Documentation <https://pymagnum.readthedocs.io/>`_
22+
23+
`Changes <https://github.com/CharlesGodwin/pymagnum/blob/master/CHANGES.rst>`_
24+
25+
..
26+
Testing
27+
28+
**This is release candidate only**
29+
30+
`Documentation <https://godwin.ca/magnum/>`_
31+
32+
`Changes <https://github.com/CharlesGodwin/pymagnum/blob/Pre-release-2.0/CHANGES.rst>`_

‎build_draft.cmd

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
rd /s /q dist
2-
rd /s /q pymagnum.egg-info
3-
python setup.py clean build
4-
python setup.py sdist --formats=zip
1+
call make.bat clean
2+
call make.bat html
3+
@REM generated documentation is in ../build/html
4+
rd /s /q dist
5+
rd /s /q pymagnum.egg-info
6+
python setup.py clean build
7+
python setup.py sdist --formats=zip

‎build_draft.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
#!/bin/bash
2-
rm -R -f dist
3-
rm -R -f pymagnum.egg-info
4-
python3 setup.py clean build
5-
python3 setup.py sdist --formats=zip
1+
#!/bin/bash
2+
rm -R -f dist
3+
rm -R -f pymagnum.egg-info
4+
python setup.py clean build
5+
python setup.py sdist --formats=zip

‎build_pypi.cmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ rd /s /q pymagnum.egg-info
44
python setup.py sdist bdist_wheel
55
python -m twine upload -u CharlesGodwin dist/*
66
@echo Use this to install
7-
@echo sudo pips install --upgrade pymagnum==VERSION
7+
@echo sudo pip install --upgrade pymagnum==VERSION

‎build_test.cmd

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
python setup.py clean
2-
rd /s /q dist
3-
rd /s /q pymagnum.egg-info
4-
python setup.py sdist bdist_wheel
5-
python -m twine upload --verbose -u CharlesG --repository-url https://test.pypi.org/legacy/ dist/*
6-
@echo Use this to install
7-
@echo sudo pip3 install --upgrade -i https://test.pypi.org/simple/ pymagnum==VERSION
1+
python setup.py clean
2+
rd /s /q dist
3+
rd /s /q pymagnum.egg-info
4+
python setup.py sdist bdist_wheel
5+
python -m twine upload --verbose -u CharlesG --repository-url https://test.pypi.org/legacy/ dist/*
6+
@echo Use this to install
7+
@echo sudo pip install --upgrade -i https://test.pypi.org/simple/ pymagnum==VERSION

0 commit comments

Comments
 (0)