<!-- markdownlint-disable first-line-heading --> <!-- markdownlint-disable no-inline-html -->

<img src="https://raw.githubusercontent.com/NickM-27/swatch/master/assets/swatch.png" alt="Swatch icon" width="16%" align="right" style="float: right; margin: 10px 0px 20px 20px;" />

swatch

Color detection in images to capture presence of known objects.

Why?

There is great object and face detection software out there, but sometimes AI detection is overkill or not suitable different types of objects. Swatch was created to create an easy to use API to detect the presence of objects of known color in expected places.

In this example you can see a cropped section of the street with a trash can. Then, using expected color bounds, the parts of the image that don't match the expected color are masked away. If a significant enough amount of pixels are left that match the color then it can be considered a true positive.

Features

• REST API to be invoked by other applications
• Intuitive frontend UI to manage swatch and use the Color Playground to fine tune colors for the config.
• HomeAssistant Integration
• HomeAssistant Addon

Web UI

Color Playground

<img src="https://raw.githubusercontent.com/NickM-27/swatch/master/assets/color-playground.png" alt="Swatch Color Playground" />

Configuration

A config.yaml file must be created and mapped to /config

Check out GitHub Docs for example and more instructions on creating the config file.

Adding Objects

Check out the Color Setup Docs for how to setup objects and fine the color values to use.

API References

Check out GitHub Docs for the API reference.

Contributing

Contributions are very much welcome!

For instructions on how to get started, see the contributing section

Donations

If you would like to make a donation to support development, please use GitHub Sponsors.