Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/p0l0/hapetwalk

Home Assistant integration for petWALK.control
https://github.com/p0l0/hapetwalk

custom-component hacs-integration home-assistant homeassistant petwalk python

Last synced: about 2 months ago
JSON representation

Home Assistant integration for petWALK.control

Host: GitHub
URL: https://github.com/p0l0/hapetwalk
Owner: p0l0
License: mit
Created: 2022-04-28T19:49:56.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-07-23T16:26:43.000Z (6 months ago)
Last Synced: 2024-07-24T14:05:09.198Z (6 months ago)
Topics: custom-component, hacs-integration, home-assistant, homeassistant, petwalk, python
Language: Python
Homepage:
Size: 201 KB
Stars: 2
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# PetWALK Homeassistant Component

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
[![GitHub release](https://img.shields.io/github/release/p0l0/hapetwalk)](https://github.com/p0l0/hapetwalk/releases)
![Build Pipeline](https://img.shields.io/github/actions/workflow/status/p0l0/hapetwalk/validate.yaml)
![License](https://img.shields.io/github/license/p0l0/hapetwalk)

![Project maintenance](https://img.shields.io/badge/maintainer-%40p0l0-blue.svg)
[![BuyMeCoffee](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://www.buymeacoffee.com/p0l0)

Custom Component to integrate PetWALK Door into [Home Assistant](https://www.home-assistant.io/).

**This integration will set up the following platforms.**

| Platform | Description |
|-------------------------------------------|---------------------------------------------------------------------------------------|
| `switch._brightness_sensor` | Switch to enable/disable the Brightness Sensor |
| `switch._motion_in` | Switch to enable/disable Motion IN |
| `switch._motion_out` | Switch to enable/disable Motion OUT |
| `switch._rfid` | Switch to enable/disable the RFID Feature |
| `switch._system` | Switch to turn on and off the System |
| `switch._time` | Switch to enable/disable the Time Schedule |
| `cover._door` | Open and close the Door |
| `device_tracker._` | For each Pet, one Device Tracker entity is created, showing if Pet is at Home or not. |

> If you only have rfid activated for entry, you can activate the option '*Include all Door events' which will provide following entities:

| Platform | Description |
|----------------------------------------------|-------------------------------------------------------|
| `sensor.__last_event` | Exposes the timestamp for the last event for each Pet |

# Installation
## HACS (Recommended)
This is currently not an official HACS integration and repository needs to be added to HACS.

Assuming you have already installed and configured HACS, follow these steps:

1. Navigate to the HACS integrations page
2. Choose Integrations under HACS
3. Click on the three small dots in the upper right corner and select `Custom repositories` and add this URL:
```bash
https://github.com/p0l0/hapetwalk/
```
4. Click the '+' button on the bottom of the page
5. Search for "Petwalk", choose it, and click install in HACS
6. Ready! Now continue with the configuration.

# Configuration

## Through the interface
1. Navigate to `Settings > Devices & Services` and then click `Add Integration`
2. Search for `Petwalk`
4. Enter your credentials and the IP of the PetWALK.control device

# Legal notice
This is a personal project and isn't in any way affiliated with, sponsored or endorsed by [PetWALK](https://www.petwalk.at/).

All product names, trademarks and registered trademarks in (the images in) this repository, are property of their respective owners. All images in this repository are used by the project for identification purposes only.