lecore 0.2.1__tar.gz → 0.2.2__tar.gz

{lecore-0.2.1/src/lecore.egg-info → lecore-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lecore
-Version: 0.2.1
+Version: 0.2.2
 Summary: Logic Elements core utilities
 Author-email: Jan Bartovský <jan.bartovsky@logicelements.cz>
 License-Expression: MIT
@@ -34,6 +34,7 @@ Dynamic: license-file
 
 # LE core package
 
+[![CI](https://github.com/LogicElements/lecore/actions/workflows/ci.yml/badge.svg)](https://github.com/LogicElements/lecore/actions/workflows/ci.yml)
 [![PyPI](https://img.shields.io/pypi/v/lecore)](https://pypi.org/project/lecore/)
 [![Python](https://img.shields.io/pypi/pyversions/lecore)](https://pypi.org/project/lecore/)
 [![License](https://img.shields.io/pypi/l/lecore)](LICENSE)
@@ -76,11 +77,12 @@ New device class (in the directory with the register map): `python -m lecore new
 
 ## Documentation
 
-- [Devices](doc/devices.md) - RTD Emulator, VMS-1502 RTD Meter, Phase Detector, FG-320
 - [Creating a new device](doc/new-device.md)
-- [Looger](doc/looger.md)
+- [Device API](doc/api.md) - Modbus and LeBin device: read, write, firmware upgrade
 - [User interfaces](doc/user-interfaces.md) - graphical and terminal register browser
+- [Devices](doc/devices.md) - RTD Emulator, VMS-1502 RTD Meter, Phase Detector, FG-320
 - [Build and release](doc/build.md)
+- [Looger](doc/looger.md)
 
 ## License
 

{lecore-0.2.1 → lecore-0.2.2}/README.md

@@ -1,53 +1,55 @@
-# LE core package
-
-[![PyPI](https://img.shields.io/pypi/v/lecore)](https://pypi.org/project/lecore/)
-[![Python](https://img.shields.io/pypi/pyversions/lecore)](https://pypi.org/project/lecore/)
-[![License](https://img.shields.io/pypi/l/lecore)](LICENSE)
-
-Core Python utilities for Logic Elements:
-- Looger client
-- Proprietary LeBin protocol
-- Proprietary Modbus RTU register map handling - VisualModbus
-- Test frame
-- Logic Elements devices
-
-## Install
-
-Requires Python 3.9 or newer.
-
-```
-pip install lecore
-pip install --upgrade lecore
-```
-
-Optional extras: `lecore[extra]` (graphical UI, Word documentation) and `lecore[tui]` (terminal UI).
-
-## Usage
-
-```python
-import lecore.Devices.RtdEmul as RE
-
-# Create RTD emulator object and open communication at COM2 (default is COM1)
-rtd = RE.RtdEmul()
-rtd.open(comport='COM2')
-
-# Read serial number
-sn = rtd.read(RE.Reg.FACT_SERIAL_NUMBER)
-
-# Write emulated temperature at output 1
-rtd.write(RE.Reg.EMUL_TEMPERATURE_1, 30.5)
-```
-
-New device class (in the directory with the register map): `python -m lecore new-device MyDevice`, quick guide: `python -m lecore guide`.
-
-## Documentation
-
-- [Devices](doc/devices.md) - RTD Emulator, VMS-1502 RTD Meter, Phase Detector, FG-320
-- [Creating a new device](doc/new-device.md)
-- [Looger](doc/looger.md)
-- [User interfaces](doc/user-interfaces.md) - graphical and terminal register browser
-- [Build and release](doc/build.md)
-
-## License
-
-MIT, see [LICENSE](LICENSE).
+# LE core package
+
+[![CI](https://github.com/LogicElements/lecore/actions/workflows/ci.yml/badge.svg)](https://github.com/LogicElements/lecore/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/lecore)](https://pypi.org/project/lecore/)
+[![Python](https://img.shields.io/pypi/pyversions/lecore)](https://pypi.org/project/lecore/)
+[![License](https://img.shields.io/pypi/l/lecore)](LICENSE)
+
+Core Python utilities for Logic Elements:
+- Looger client
+- Proprietary LeBin protocol
+- Proprietary Modbus RTU register map handling - VisualModbus
+- Test frame
+- Logic Elements devices
+
+## Install
+
+Requires Python 3.9 or newer.
+
+```
+pip install lecore
+pip install --upgrade lecore
+```
+
+Optional extras: `lecore[extra]` (graphical UI, Word documentation) and `lecore[tui]` (terminal UI).
+
+## Usage
+
+```python
+import lecore.Devices.RtdEmul as RE
+
+# Create RTD emulator object and open communication at COM2 (default is COM1)
+rtd = RE.RtdEmul()
+rtd.open(comport='COM2')
+
+# Read serial number
+sn = rtd.read(RE.Reg.FACT_SERIAL_NUMBER)
+
+# Write emulated temperature at output 1
+rtd.write(RE.Reg.EMUL_TEMPERATURE_1, 30.5)
+```
+
+New device class (in the directory with the register map): `python -m lecore new-device MyDevice`, quick guide: `python -m lecore guide`.
+
+## Documentation
+
+- [Creating a new device](doc/new-device.md)
+- [Device API](doc/api.md) - Modbus and LeBin device: read, write, firmware upgrade
+- [User interfaces](doc/user-interfaces.md) - graphical and terminal register browser
+- [Devices](doc/devices.md) - RTD Emulator, VMS-1502 RTD Meter, Phase Detector, FG-320
+- [Build and release](doc/build.md)
+- [Looger](doc/looger.md)
+
+## License
+
+MIT, see [LICENSE](LICENSE).

{lecore-0.2.1 → lecore-0.2.2}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "lecore"
 description = "Logic Elements core utilities"
-version = "0.2.1"
+version = "0.2.2"
 authors = [
   { name="Jan Bartovský", email="jan.bartovsky@logicelements.cz" },
 ]

{lecore-0.2.1 → lecore-0.2.2}/src/lecore/Devices/LeBinDev.py

@@ -228,8 +228,8 @@ class LeBinDev(DeviceBase):
         check_file(file, "File to send")
         # Run upgrade procedure
         self._upg.load_file(file)
-        ret = self._upg.run()
-        return ret == 0
+        # LeBin upgrade returns True on success (unlike Modbus return code 0)
+        return bool(self._upg.run())
 
     def _visual(self) -> None:
         """

{lecore-0.2.1 → lecore-0.2.2}/src/lecore/Devices/ModbusDev.py

@@ -190,6 +190,16 @@ class ModbusDev(DeviceBase):
         self.close()
         return self._vis.handle(timeout)
 
+    def enable_log(self, enable: bool = True, directory: Optional[PathLike] = None) -> None:
+        """
+        Enable or disable logging of communication into file (disabled by default)
+        :param enable: True to enable, False to disable logging into file
+        :param directory: Directory of log files, default 'log/' in current working directory
+        """
+        if self._vis is None:
+            raise RuntimeError(f"{type(self).__name__}: device is not initialized")
+        self._vis.log.enable_file(enable, directory)
+
     def textual(self) -> None:
         """
         Run textual user interface application

{lecore-0.2.1 → lecore-0.2.2}/src/lecore/QUICKSTART.md

@@ -29,6 +29,7 @@ Python API: `lecore.new_device("MyDevice", directory=".", ...)` returns `{path:
 | `VisualSettings.json` | created if missing (Modbus only) - GUI settings incl. default `slave_address` |
 | `__init__.py` | created if missing - exports device class, register class and alias `Reg`; existing one is not changed |
 | `__main__.py` | created if missing - command line: `python -m <package> [--comport COM5] [--slave 3] [--read NAME ...] [--list] [--gui \| --tui]` |
+| `CLAUDE.md` | created if missing - short API and command line notes (Modbus/LeBin) for AI assistants; existing one is not changed |
 
 Run it from the package directory as `python . [options]`, or from its parent as `python -m mydevice [options]`;
 without options all registers are read and printed. `python MyDevice.py` does not work (relative imports).