Skip to content

Add CUPS sensor docs #1377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions source/_components/sensor.cups.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: page
title: "CUPS Sensor"
description: "Instructions how to integrate CUPS sensors into Home Assistant."
date: 2016-10-30 12:10
sidebar: true
comments: false
sharing: true
footer: true
logo: cups.png
ha_category: System Monitoring
ha_iot_class: "Local Polling"
ha_release: 0.32
---


The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers.

To set up the sensor the "Queue Name" of the printer is needed. The fastest way to get it, is to visit the CUPS webinterface at "http://[IP ADDRESS PRINT SERVER]:631" and go to "Printers".

<p class='img'>
<img src='{{site_root}}/images/screenshots/cups-sensor.png' />
</p>

To enable the CUPS sensor, add the following lines to your `configuration.yaml`:

```yaml
# Example configuration.yaml entry
sensor:
- platform: cups
printers:
- C410
- C430
```

Configuration variables:

- **printers** array (*Required*): List of printers to add.


<p class='note'>
You will need to install the `python3-dev` or `python3-devel` and the development files for CUPS (`libcups2-dev` or`cups-devel`) package on your system manually (eg. `sudo apt-get install python3-dev libcups2-dev` or `sudo dnf -y install python3-devel cups-devel`) along with a compiler (`gcc`).
</p>
Binary file added source/images/screenshots/cups-sensor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/supported_brands/cups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.