Skip to content

Commit 8e7c387

Browse files
dgreifdgreif
committed
feat: rename npm modules to match functionality
BREAKING CHANGE: `homebridge-ring-alarm` renamed to `homebridge-ring`. The config for homebridge should now be `"platform": "Ring"` instead of `"platform": "RingAlarm"`. This config change will happen automatically the first time you start homebridge with the new version, but it will cause homebridge to error out after the config is changed. You will see a log that the config has changed and you can restart homebridge. BREAKING CHANGE: `@dgreif/ring-alarm` renamed to `ring-client-api`. The exported class is now `RingApi` instead of `RingAlarmApi`. Proper usage now looks like `import { RingApi } from "ring-client-api"`.
1 parent d6734ce commit 8e7c387

25 files changed

+112
-65
lines changed

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ring-alarm
1+
# ring-client-api
22

33
[![CircleCI](https://circleci.com/gh/dgreif/ring.svg?style=svg)](https://circleci.com/gh/dgreif/ring)
44
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=HD9ZPB34FY428&currency_code=USD&source=url)
@@ -8,16 +8,16 @@ This is an unofficial TypeScript api for [Ring Doorbells](https://shop.ring.com/
88
the [Ring Alarm System](https://shop.ring.com/pages/security-system),
99
[Ring Smart Lighting](https://shop.ring.com/pages/smart-lighting),
1010
and third party devices that connect to the Ring Alarm System.
11-
Built to support the [homebridge-ring-alarm Plugin](./homebridge)
11+
Built to support the [homebridge-ring Plugin](./homebridge)
1212

1313
## Installation
1414

15-
`npm i @dgreif/ring-alarm`
15+
`npm i ring-client-api`
1616

1717

1818
## Setup and Config
1919
```js
20-
import { RingApi } from '@dgreif/ring-alarm'
20+
import { RingApi } from 'ring-client-api'
2121

2222
const ringApi = new RingApi({
2323
email: 'some.one@website.com',
@@ -32,7 +32,7 @@ const ringApi = new RingApi({
3232

3333
### Optional Parameters
3434
`locationIds`: Allows you to limit the results to a specific set of locations.
35-
This is mainly useful for the [homebridge-ring-alarm Plugin](./homebridge), but can also be used if you only care about
35+
This is mainly useful for the [homebridge-ring Plugin](./homebridge), but can also be used if you only care about
3636
listening for events at a subset of your locations and don't want to create websocket connections to _all_ of your locations.
3737
This will also limit the results for `ringApi.getCameras()` to the configured locations.
3838
If this option is not included, all locations will be returned.
@@ -65,7 +65,7 @@ Once you have acquired the desired location, you can start
6565
to interact with associated devices. These devices include ring alarm, ring lighting,
6666
and third party devices connected to ring alarm
6767
```js
68-
import { RingDeviceType } from '@dgreif/ring-alarm'
68+
import { RingDeviceType } from 'ring-client-api'
6969

7070
const devices = await location.getDevices()
7171
const baseStation = devices.find(device => device.data.deviceType === RingDeviceType.BaseStation)
@@ -116,11 +116,11 @@ v3 exports a full `RingApi` object instead of a single `getLocations` method.
116116

117117
```typescript
118118
// v2
119-
import { getLocations } from '@dgreif/ring-alarm'
119+
import { getLocations } from 'ring-client-api'
120120
const locations = await getLocations(options)
121121

122122
// v3
123-
import { RingApi } from '@dgreif/ring-alarm'
123+
import { RingApi } from 'ring-client-api'
124124
const ringApi = new RingApi(options),
125125
locations = await ringApi.getLocations(), // same locations object form v2
126126
cameras = await ringApi.getCameras() // new! all cameras from all locations
@@ -129,9 +129,9 @@ const ringApi = new RingApi(options),
129129
v3 also exposes some other top level methods like `ringApi.getHistory()` and `ringApi.fetchRingDevices()`.
130130
Since these are global across all locations, it no longer made sense to export a single `getLocations` method.
131131

132-
## homebridge-ring-alarm
132+
## homebridge-ring
133133

134-
The `homebridge-ring-alarm` is also maintained in this repo. It's readme can be found in [the `homebridge` directory](./homebridge)
134+
The `homebridge-ring` is also maintained in this repo. It's readme can be found in [the `homebridge` directory](./homebridge)
135135

136136
## Credits
137137

‎api/api.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { RingCamera } from './ring-camera'
1212
import { EMPTY, merge, Subject } from 'rxjs'
1313
import { debounceTime, switchMap, throttleTime } from 'rxjs/operators'
1414

15-
export interface RingAlarmOptions {
15+
export interface RingApiOptions {
1616
locationIds?: string[]
1717
cameraStatusPollingSeconds?: number
1818
cameraDingsPollingSeconds?: number
@@ -23,7 +23,7 @@ export class RingApi {
2323

2424
private locations = this.fetchAndBuildLocations()
2525

26-
constructor(public readonly options: RingAlarmOptions & RingAuth) {}
26+
constructor(public readonly options: RingApiOptions & RingAuth) {}
2727

2828
async fetchRingDevices() {
2929
const {

‎api/util.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { red } from 'colors'
33
import { randomBytes } from 'crypto'
44
import { createInterface } from 'readline'
55

6-
const logger = debug('ring-alarm')
6+
const logger = debug('ring')
77

88
export function delay(milliseconds: number) {
99
return new Promise(resolve => {

‎homebridge/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# homebridge-ring-alarm
1+
# homebridge-ring
22

33
[![CircleCI](https://circleci.com/gh/dgreif/ring.svg?style=svg)](https://circleci.com/gh/dgreif/ring)
44
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=HD9ZPB34FY428&currency_code=USD&source=url)
@@ -14,17 +14,17 @@ and third party devices that connect to the Ring Alarm System.
1414

1515
Assuming a global installation of `homebridge`:
1616

17-
`npm i -g homebridge-ring-alarm`
17+
`npm i -g homebridge-ring`
1818

1919
## Homebridge Configuration
2020

21-
Add the `RingAlarm` platform in your homebridge `config.json` file.
21+
Add the `Ring` platform in your homebridge `config.json` file.
2222

2323
```js
2424
{
2525
"platforms": [
2626
{
27-
"platform": "RingAlarm",
27+
"platform": "Ring",
2828
"email": "some.one@website.com",
2929
"password": "abc123!#",
3030

‎homebridge/base-accessory.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import { HAP } from './hap'
33
import Service = HAP.Service
44
import { debounceTime, distinctUntilChanged, map, take } from 'rxjs/operators'
55
import { Observable, Subject } from 'rxjs'
6-
import { RingAlarmPlatformConfig } from './config'
6+
import { RingPlatformConfig } from './config'
77

88
export abstract class BaseAccessory<T extends RingDevice | RingCamera> {
99
abstract readonly device: T
1010
abstract readonly accessory: HAP.Accessory
1111
abstract readonly logger: HAP.Log
12-
abstract readonly config: RingAlarmPlatformConfig
12+
abstract readonly config: RingPlatformConfig
1313

1414
getService(serviceType: HAP.Service, name = this.device.name) {
1515
if (process.env.RING_DEBUG) {

‎homebridge/base-device-accessory.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { HAP, hap } from './hap'
33
import Service = HAP.Service
44
import { debounceTime, distinctUntilChanged, map } from 'rxjs/operators'
55
import { Subject } from 'rxjs'
6-
import { RingAlarmPlatformConfig } from './config'
6+
import { RingPlatformConfig } from './config'
77
import { BaseAccessory } from './base-accessory'
88

99
function getBatteryLevel({ batteryLevel, batteryStatus }: RingDeviceData) {
@@ -51,7 +51,7 @@ export abstract class BaseDeviceAccessory extends BaseAccessory<RingDevice> {
5151
abstract readonly device: RingDevice
5252
abstract readonly accessory: HAP.Accessory
5353
abstract readonly logger: HAP.Log
54-
abstract readonly config: RingAlarmPlatformConfig
54+
abstract readonly config: RingPlatformConfig
5555

5656
protected constructor() {
5757
super()

‎homebridge/base-station.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { BaseDeviceAccessory } from './base-device-accessory'
22
import { RingDevice } from '../api'
33
import { HAP } from './hap'
4-
import { RingAlarmPlatformConfig } from './config'
4+
import { RingPlatformConfig } from './config'
55

66
export class BaseStation extends BaseDeviceAccessory {
77
constructor(
88
public readonly device: RingDevice,
99
public readonly accessory: HAP.Accessory,
1010
public readonly logger: HAP.Log,
11-
public readonly config: RingAlarmPlatformConfig
11+
public readonly config: RingPlatformConfig
1212
) {
1313
super()
1414
}

‎homebridge/beam.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { RingDevice, RingDeviceType } from '../api'
22
import { HAP, hap } from './hap'
3-
import { RingAlarmPlatformConfig } from './config'
3+
import { RingPlatformConfig } from './config'
44
import { BaseDeviceAccessory } from './base-device-accessory'
55

66
export class Beam extends BaseDeviceAccessory {
@@ -12,7 +12,7 @@ export class Beam extends BaseDeviceAccessory {
1212
public readonly device: RingDevice,
1313
public readonly accessory: HAP.Accessory,
1414
public readonly logger: HAP.Log,
15-
public readonly config: RingAlarmPlatformConfig
15+
public readonly config: RingPlatformConfig
1616
) {
1717
super()
1818

‎homebridge/camera.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { HAP, hap } from './hap'
2-
import { RingAlarmPlatformConfig } from './config'
2+
import { RingPlatformConfig } from './config'
33
import { RingCamera } from '../api'
44
import { BaseAccessory } from './base-accessory'
55
import { map, mapTo } from 'rxjs/operators'
@@ -10,7 +10,7 @@ export class Camera extends BaseAccessory<RingCamera> {
1010
public readonly device: RingCamera,
1111
public readonly accessory: HAP.Accessory,
1212
public readonly logger: HAP.Log,
13-
public readonly config: RingAlarmPlatformConfig
13+
public readonly config: RingPlatformConfig
1414
) {
1515
super()
1616
const { Characteristic, Service } = hap,

‎homebridge/co-alarm.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { BaseDeviceAccessory } from './base-device-accessory'
22
import { RingDevice } from '../api'
33
import { HAP, hap } from './hap'
4-
import { RingAlarmPlatformConfig } from './config'
4+
import { RingPlatformConfig } from './config'
55

66
export class CoAlarm extends BaseDeviceAccessory {
77
constructor(
88
public readonly device: RingDevice,
99
public readonly accessory: HAP.Accessory,
1010
public readonly logger: HAP.Log,
11-
public readonly config: RingAlarmPlatformConfig
11+
public readonly config: RingPlatformConfig
1212
) {
1313
super()
1414

0 commit comments

Comments
 (0)