Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.52 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.52 KB

made-with-python Donate

Whatpulse Sensor Component

This is a Custom Component for Home-Assistant (https://home-assistant.io) that has sensors for various stats from Whatpulse.

About

Whatpulse is a application that measures your keyboard/mouse usage, down- & uploads and your uptime. This component queries the Whatpulse API for a configured user and gets the values for those statistics.

Installation

HACS - Recommended

  • Have HACS installed, this will allow you to easily manage and track updates.
  • Search for 'Whatpulse'.
  • Click Install below the found integration.
  • Configure using the configuration instructions below.
  • Restart Home-Assistant.

Manual

  • Copy directory custom_components/whatpulse to your <config dir>/custom_components directory.
  • Configure with config below.
  • Restart Home-Assistant.

Usage

To use this component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry

sensor:
  - platform: whatpulse
    username: an_user_name

Configuration variables:

  • username (Required): The username for which you want to get the statistics. This data is open, so you can get data for any user.

Donation

Donate