Skip to content

Commit

Permalink
roomba2 to roomba
Browse files Browse the repository at this point in the history
  • Loading branch information
donavanbecker committed Jan 25, 2025
1 parent 39cd677 commit 78a6e63
Show file tree
Hide file tree
Showing 14 changed files with 291 additions and 290 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Show your homebridge config.json here
* **Node.js Version**: <!-- node -v -->
* **NPM Version**: <!-- npm -v -->
* **Homebridge Version**: <!-- homebridge -V -->
* **Homebridge Roomba2 Plugin Version**:
* **Homebridge Roomba Plugin Version**:
* **Homebridge Config UI X Version**:
* **Operating System**: Raspbian / Ubuntu / Debian / Windows / macOS / Docker
* **Process Supervisor**: Docker / Systemd / init.d / pm2 / launchctl / hb-service / other / none
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ body:
required: true
- type: input
attributes:
label: Homebridge Roomba2 Plugin Version
label: Homebridge Roomba Plugin Version
placeholder: v1.1.0
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Homebridge Discord Channel for Roomba2
- name: Homebridge Discord Channel for Roomba
url: https://discord.gg/8fpZA4S
about: Please ask and answer questions here.
- name: homebridge-roomba - Pull Requests
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ body:
required: true
- type: input
attributes:
label: Homebridge Roomba2 Plugin Version
label: Homebridge Roomba Plugin Version
placeholder: v1.1.0
validations:
required: true
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/beta-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
if: ${{ github.repository == 'homebridge-plugins/homebridge-roomba' }}
uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
with:
title: "Roomba2 Beta Release"
title: "Roomba Beta Release"
description: |
Version `v${{ needs.publish.outputs.NPM_VERSION }}`
url: "https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
if: ${{ github.repository == 'homebridge-plugins/homebridge-roomba' }}
uses: homebridge/.github/.github/workflows/discord-webhooks.yml@latest
with:
title: "Roomba2 Release"
title: "Roomba Release"
description: |
Version `v${{ needs.publish.outputs.NPM_VERSION }}`
url: "https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v${{ needs.publish.outputs.NPM_VERSION }}"
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# homebridge-roomba

<a href="https://www.npmjs.com/package/homebridge-roomba"><img title="npm version" src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-roomba" ></a>
<a href="https://www.npmjs.com/package/homebridge-roomba"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-roomba?label=downloads" ></a>
<a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-roomba"><img title="npm version" src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-roomba" ></a>
<a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-roomba"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-roomba?label=downloads" ></a>
[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

</span>
Expand All @@ -25,14 +25,14 @@ a few seconds).

## Installation

1. Use the [Homebridge UI](https://github.com/oznu/homebridge-config-ui-x)’s Plugins screen to search for and install "homebridge-roomba"
1. Use the [Homebridge UI](https://github.com/homebridge/homebridge-config-ui-x)’s Plugins screen to search for and install "homebridge-roomba"
2. Follow [Setup](#setup) to get Roomba credentials and to configure your Roomba
3. Restart Homebridge

### Manual Installation

1. Install Homebridge: `sudo npm i -g homebridge --unsafe-perm`
2. Download this plugin: `sudo npm i -g homebridge-roomba`
2. Download this plugin: `sudo npm i -g @homebridge-plugins/homebridge-roomba`
3. Follow [Setup](#setup) to get Roomba credentials
4. Enter Roomba's credentials in your `config.json` file.
5. Restart Homebridge
Expand All @@ -48,16 +48,16 @@ a few seconds).

## Configuration

This plugin supports GUI-based configuration using [Config-Ui-X](https://github.com/oznu/homebridge-config-ui-x), which is the recommended
This plugin supports GUI-based configuration using [Homebridge UI](https://github.com/homebridge/homebridge-config-ui-x), which is the recommended
approach for configuring your Roomba.

### Manual configuration

Here is example JSON for configuring a Roomba2 accessory:
Here is example JSON for configuring a Roomba accessory:

```json
{
"accessory": "Roomba2",
"accessory": "Roomba",
"name": "Roomba",
"model": "960",
"blid": "1234567890",
Expand Down Expand Up @@ -88,7 +88,7 @@ Here is example JSON for configuring a Roomba2 accessory:

| Key | Description | Default Value |
| ---------------------- | ----------------------------------------------------------------------------------- | ------------- |
| `accessory` | Loads this plugin. Must be set to `Roomba2` | |
| `accessory` | Loads this plugin. Must be set to `Roomba` | |
| `name` | The name of your Roomba as it should appear in Homebridge and HomeKit | |
| `model` | The model of your Roomba as you'd like it to appear in HomeKit | |
| `serialnum` | The serial number as you'd like it to appear in HomeKit | |
Expand Down
Loading

0 comments on commit 78a6e63

Please sign in to comment.