https://github.com/regaw-leinad/homebridge-winix-purifiers-collect
Add support for more Winix purifiers
https://github.com/regaw-leinad/homebridge-winix-purifiers-collect
Last synced: 2 months ago
JSON representation
Add support for more Winix purifiers
- Host: GitHub
- URL: https://github.com/regaw-leinad/homebridge-winix-purifiers-collect
- Owner: regaw-leinad
- Created: 2024-12-04T06:01:28.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T04:30:28.000Z (4 months ago)
- Last Synced: 2025-02-02T18:52:56.749Z (4 months ago)
- Language: TypeScript
- Size: 150 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Homebridge Winix Purifiers Data Collection Tool
This project helps collect data to support more models of Winix purifiers for
the [homebridge-winix-purifiers](https\://github.com/regaw-leinad/homebridge-winix-purifiers) Homebridge plugin. Follow
the steps below to clone, set up, and run the tool to contribute data.
## How It Works
- **Step 1**: The script will prompt you to power off and then power on your device to ensure it is in its default
state.
- **Step 2**: Follow each prompt to perform specific actions in the Winix app for the purifier, then hit Enter to record
the state after each action. You can also skip any action if it is not applicable.
- **Step 3**: You can add custom actions if needed to ensure all functionalities are covered.
- **Step 4**: At the end, the tool will provide a JSON payload with all recorded data.
- **Step 5**: Create a new issue in this repository and attach the JSON payload from the script. This will help me
manage new data contributions effectively.
## Prerequisites
- Node.js (version 18 or higher recommended)
- npm or Yarn package manager
## Getting Started
### 1. Clone the Repository
```sh
git clone https://github.com/regaw-leinad/homebridge-winix-purifiers-collector.git
cd homebridge-winix-purifiers-collector
```
### 2. Install Dependencies
Install the required dependencies for the project.
#### Using npm:
```sh
npm install
```
#### Using Yarn:
```sh
yarn
```
### 3. Find Your Device ID
To find your Device ID, follow these steps:
1. Open the **Winix Purifiers plugin config** in Homebridge.
2. Click the **"Configure Devices ->"** button.
3. Select the tab for the purifier you want to collect data for.
4. Fill in one of the text boxes, such as the **"Name"** field to make an override.
5. Click the **"Save All"** button to close the device configure section.
6. Click **Save** to close the plugin config.
7. Press the **...** menu on the plugin and click the **"JSON Config"** menu option.
8. Find and copy your **deviceId** in the JSON payload under the `deviceOverrides` section.
### 4. Run the Data Collection Script
To run the data collection script, use the following command with your device ID:
#### Using npm:
```sh
npm run collect
```
#### Using Yarn:
```sh
yarn collect
```
> **Note**: You will need to provide the `deviceId` as an argument to the command.
### 5. Create a New Issue
Create a new issue [HERE](https://github.com/regaw-leinad/homebridge-winix-purifiers-collect/issues/new/choose) and fill
in the template with all the required information.
---
Thank you for your contribution!