Metadata-Version: 2.4
Name: scietex.hal.qcm
Version: 1.1.2
Summary: Scietex Quartz Microbalance HAL package
Author-email: Anton Bondarenko <bond.anton@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Anton Bondarenko
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/bond-anton/scietex.hal.qcm
Project-URL: Bug Tracker, https://github.com/bond-anton/scietex.hal.qcm/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: msgspec[yaml]>=0.20.0
Requires-Dist: scietex.hal.serial<2.0.0,>=1.3.0
Provides-Extra: dev
Requires-Dist: tox; extra == "dev"
Provides-Extra: test
Requires-Dist: flake8; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-asyncio; extra == "test"
Provides-Extra: lint
Requires-Dist: pylint; extra == "lint"
Dynamic: license-file

# scietex.hal.qcm

The `scietex.hal.qcm` package is a Python library for interfacing with Quartz Microbalance (QCM).
It provides an abstract base class (`QCM`), which in its turn inherits `scietex.hal.serial.RS485Client`.
The concrete implementations for two models of QCM manufactured by Scietex and CYKY are provided.

## Features
- Abstract base class (`VFD`) for consistent VFD implementations.
- Implemented VFD models:
  - `Scietex ftmONE`.
  - `CYKY TM106B`.

## Installation
Install the package via pip (assuming it’s published to PyPI):
```bash
pip install scietex.hal.qcm
```

Alternatively, clone the repository and install locally:
```bash
git clone https://github.com/bond-anton/scietex.hal.qcm.git
cd scietex.hal.qcm
pip install .
```

## Requirements

 - Python 3.9 or higher.
 - `scietex.hal.serial` (For RS485 communication support).

## Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a feature branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -m "Add your message"`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a Pull Request.

Please include tests (if applicable) and follow PEP 8 style guidelines.

## License

This project is licensed under the **MIT License** - see the LICENSE file for details.
