Metadata-Version: 2.4
Name: ovos-PHAL-plugin-mk2-fan-control
Version: 0.0.3a1
Summary: An OVOS PHAL plugin to control the fan on the mark2 dev kit
Author-email: builderjer <builderjer@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/OpenVoiceOS/ovos-PHAL-plugin-mk2-v6-fan-control
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ovos-plugin-manager<3.0.0,>=2.1.0
Requires-Dist: ovos-i2c-detection>=0.0.0a5
Dynamic: license-file

# ovos-PHAL-plugin-mk2-v6-fan-control

**Compatible with**
* Mycroft Mark2 dev kit

# Usage

There are a few ways for this plugin to get enabled.

* Enable manually

Add this to your `~/.config/mycroft/mycroft.conf`

```json
{
    "PHAL": {
        "ovos-PHAL-plugin-mk2-v6-fan-control": {
            "enabled": true
        }
    }
}
```
With this configuration, no other validation checks are made.  It is assuming you have a compatible HAT installed.

* Automatically with [ovos-i2csound](https://github.com/OpenVoiceOS/ovos-i2csound)

When `ovos-i2csound` is installed and running, it creates a file at `/etc/OpenVoiceOS/i2c_platform` with the HAT name it detected.  This plugin then checks that file and if a compatible HAT is detected, the plugin is activated.

* Automatically with hardware detection

If the above two options don't work, the plugin tries to detect a compatible HAT using `i2c-detect`.  If a compatible device address is found, the plugin will activate.

From this point, if you are running OVOS on a Mark2 dev kit, your fan should be automatically controlled.

### Configuration

The temperature at which the fan turns on can be configured

```json
{
    "PHAL": {
        "ovos-PHAL-plugin-mk2-v6-fan-control": {
            "max_fanless_temp": 60.0,
            "max_fan_temp": 80.0
        }
    }
}
```

`"max_fanless_temp"` -> This is where the fan turns on
`"max_fan_temp"` -> At this temp, the fan runs at 100%
