npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rimltempest/switchbotsdk

v0.2.4

Published

switchbotをtypescriptで操作するsdkです。

Downloads

6

Readme

CI CI

switchbotSDK

switchbotSDK とは switchbot から提供されている RestAPI を簡易的に使用ができる SDK となります。
現在はSwitchBotClientDeviceClientRemoteClientがご利用できます。

詳しいドキュメントは以下に記載されています。

使用方法

用途によって3種の関数を呼び出します。

SwtichBotClient

こちらはデバイスの状態を管理するクライアントとなります。
シーンの全取得、実行もこちらで行えます。

import { SwitchBotClient } from '@rimltempest/switchbotsdk';

const client = new SwitchBotClient(`SwitchBotのトークン`);

// サンプル(全デバイス取得)
console.log(client.getDevices());

こうすることで呼び出すことができます。

DeviceClient

こちらはSwitchBotの関連デバイス(SwitchBot、スマートプラグ、加湿器など)を利用する場合のクライアントになります。

import { DeviceClient } from '@rimltempest/switchbotsdk';

const client = new DeviceClient(`SwitchBotのトークン`);
const deviceId = 'SwitchBotの端末ID';

// サンプル(SwitchBotのBotオン/オフ)
await client.setSwitchBot(deviceId, 'on');
await client.setSwitchBot(deviceId, 'off');

こうすることで呼び出すことができます。

RemoteClient

こちらはSwitchBotHubを利用した赤外線デバイスを利用する場合のクライアントになります。

import { RemoteClient } from '@rimltempest/switchbotsdk';

const client = new RemoteClient(`SwitchBotのトークン`);
// 赤外線デバイスは
const deviceId = 'ディスプレイの端末ID';

// サンプル(赤外線デバイスのBotオン/オフ)
// 赤外線デバイスはすべてのオンオフはこの関数で行えます。
await client.setRemoteDevice(deviceId, 'on');
await client.setRemoteDevice(deviceId, 'off');

こうすることで呼び出すことができます。


フロントエンドフレームワークやバックエンドフレームワークでも使用可能です。

NestJS

// switch-bot.service.ts
import { Injectable } from '@nestjs/common';
import { config } from 'dotenv';
import {
    SwitchBotClient,
    DeviceClient,
    RemoteClient,
} from '@rimltempest/switchbotsdk';
config();

type PowerType = 'on' | 'off';

@Injectable()
export class SwitchBotService {
    #client = new SwitchBotClient(`${process.env.SWITCHBOT_ACCESS_TOKEN}`);
    #deviceCommand = new DeviceClient(`${process.env.SWITCHBOT_ACCESS_TOKEN}`);
    #remoteCommand = new RemoteClient(`${process.env.SWITCHBOT_ACCESS_TOKEN}`);

    async RoomLight(deviceId: string, power: PowerType) {
        return await this.#deviceCommand.setSwitchBot(deviceId, power);
    }

    async TVLight(deviceId: string, power: PowerType) {
        return await this.#remoteCommand.setRemoteDevice(deviceId, power);
    }

    async getDevices() {
        const device = await this.#client.getDevices();
        return device.data.body;
    }
}

// app.controller.ts
import { Controller, Get, Param } from '@nestjs/common';
import { AppService } from './app.service';
import { SwitchBotService } from 'src/switch-bot/switch-bot.service';

@Controller()
export class AppController {
    constructor(
        private readonly appService: AppService,
        private readonly _switchBot: SwitchBotService,
    ) {}

    @Get()
    getHello(@Param('deviceId') deviceId: string) {
        const res = await this._switchBot.RoomLight(deviceId, 'on');
        return res.message;
    }
}

参考

公式 SwitchBotAPI のドキュメント