利用TypeScript編寫一個簡單的Homebridge插件

前言

本教程是通過TypeScript編寫的hb-plugin,這是一個簡單的教程肃廓,但是需要具備編程基礎(chǔ)挎峦。為什么用typescript,因為ts支持異步函數(shù)搜吧,避免產(chǎn)生大量的回調(diào)市俊。


homebridge

A.需求分析

需求:實現(xiàn)在homekit中去控制一盞燈的開關(guān)。
分析:基于homebridge框架進行開發(fā)滤奈,利用socket跟主機進行網(wǎng)絡(luò)通信摆昧,進而實現(xiàn)控制。

homebridge原理圖

B.前期準(zhǔn)備

C.進行開發(fā)

1. 注冊Accessory設(shè)備

將Light插件注入到homebridge蜒程,Lightbulb是一個對象

// 注冊Accessory設(shè)備
export default function(homebridge: any) {
  Service = homebridge.hap.Service;
  Characteristic = homebridge.hap.Characteristic;
  homebridge.registerAccessory("homebridge-Lightbulb", "Lightbulb", Lightbulb);
}
2. 實例化Service服務(wù)

注冊switch時涉及到的兩個service:

  • AccessoryInformation service:每個Accessory都需要廣播與設(shè)備本身相關(guān)的信息绅你,無論其類型如何伺帘;它包含了Manufacturer(生產(chǎn)廠家)、SerialNumber(序列號)等特性
  • Lightbulb service:真正的燈光service忌锯,Lightbulb設(shè)備具有布爾特性O(shè)n伪嫁,百分比特性Brightness 等;這里我們只做一個開關(guān)燈偶垮。
constructor(log, config) {
    this.log = log;
    this.name = config["name"];

    const informationService = new Service.AccessoryInformation();
    const LightbulbService = new Service.Lightbulb(this.name);
    LightbulbService
      .getCharacteristic(Characteristic.On)
      .on("get", this.getLightOnCharacteristic.bind(this))
      .on("set", this.setLightOnCharacteristic.bind(this));
    this.LightbulbService = LightbulbService;

  }

  getServices() {
    const { LightbulbService } = this;
    return [LightbulbService];
  }
homekit支持的Accessory
3. 實例化Characteristic

就是將上面注冊的Service中的getCharacteristic這一部分具體實現(xiàn)张咳。在編程上的意思就是,實現(xiàn)聲明函數(shù)的方法针史。

// get請求  
  getLightOnCharacteristic(callback: (arg0: any) => void) {
    console.log("**************Get on Function**************");
    callback(null);
  }

// set請求 
  setLightOnCharacteristic(on: boolean, callback: (arg0: any) => void) {
    console.log("**************Set on Function:" + on + "**************");

    if (on) {
      this.socket.write(onbuf);
    } else {
      this.socket.write(offbuf);
    }
    setTimeout(function() {
      console.log(inibuf);
    }, 500); //500ms Rest init statue

    callback(null);
  }
4.建立socket

這一部分需要先導(dǎo)入typescript的net包晶伦,然后要在構(gòu)造函數(shù)里創(chuàng)建。

  constructor(log, config) {
    this.log = log;
    this.name = config["name"];

    this.socket = new net.Socket();
    this.socket.connect(8989, "localhost", function() {
      console.log("Connecte Server OK!"); 
    });
    this.socket.on("error", console.error); // logs socket error messages
  }

5.完整代碼

//mySwitch完整index.js代碼
import net from "net";

let Service: any, Characteristic: any;
let onbuf = "turn on"; //cmd: turn on
let offbuf = "turn off"; //cmd: turn off
let inibuf = "check"; //cmd: reset


// 注冊Accessory設(shè)備
export default function(homebridge: any) {
  Service = homebridge.hap.Service;
  Characteristic = homebridge.hap.Characteristic;
  homebridge.registerAccessory("homebridge-Lightbulb", "Lightbulb", Lightbulb);
}

class Lightbulb {
  log: Function;
  name: string;
  LightbulbService: any;
  socket: net.Socket;

  constructor(log, config) {
    this.log = log;
    this.name = config["name"];

    const informationService = new Service.AccessoryInformation();
    const LightbulbService = new Service.Lightbulb(this.name);
    LightbulbService
      .getCharacteristic(Characteristic.On)
      .on("get", this.getLightOnCharacteristic.bind(this))
      .on("set", this.setLightOnCharacteristic.bind(this));
    this.LightbulbService = LightbulbService;

    this.socket = new net.Socket();
    this.socket.connect(8989, "localhost", function() {
      console.log("Connecte Server OK!"); //connect ser2net
    });
    this.socket.on("error", console.error); // logs socket error messages
  }

  getServices() {
    const { LightbulbService } = this;
    return [LightbulbService];
  }

  getLightOnCharacteristic(callback: (arg0: any) => void) {
    console.log("**************Get on Function**************");
    callback(null);
  }

  setLightOnCharacteristic(on: boolean, callback: (arg0: any) => void) {
    console.log("**************Set on Function:" + on + "**************");

    if (on) {
      this.socket.write(onbuf);
    } else {
      this.socket.write(offbuf);
    }

    setTimeout(function() {
      console.log(inibuf);
    }, 500); //500ms Rest init statue

    callback(null);
  }
}

6. 打包編譯

由于使用的是typescript啄枕,所以要利用rollup和babel將其編譯成js婚陪,這樣homebridge才能識別你的插件。
這一步挺難的频祝,因為要配置一些亂七八糟的泌参,我自己也沒搞懂,所以大家上github看我的demo配置就好了常空。

7. 其他

大致開發(fā)的流程就是這樣沽一,不是太理解的可以先運行我寫的插件homebridge-lightbulb-ts-demo

  1. 去github上下載我上傳的項目漓糙,別忘記給個star
  2. 在你解壓后的文件夾下運行铣缠,npm install
  3. 然后運行npm run build
  4. 編譯完畢后,如果沒問題的話昆禽,把這個文件夾放到與homebridge平級的目錄下蝗蛙。


    image.png
  5. 配置config.json


    config.json
{
  "bridge": {
      "name": "Homebridge",
      "username": "94:A1:A2:BE:0B:30",
      "port": 59376,
      "pin": "031-45-666"
  },
  "accessories": [
      {
          "accessory": "MyLightbulb",
          "name": "燈"
      }
  ],
  "platforms": []
}
  1. 在cmd窗口運行homebridge

    運行成功

  2. 掃二維碼添加設(shè)備


    succeess
  3. 習(xí)題
    ok,now you can use siri to control your light,it will very fun.
    你可以將這個燈更改為調(diào)光燈

  4. 交流群
    homebridge交流群:107927710

8. 參考文獻

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市醉鳖,隨后出現(xiàn)的幾起案子捡硅,更是在濱河造成了極大的恐慌,老刑警劉巖盗棵,帶你破解...
    沈念sama閱讀 219,039評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件壮韭,死亡現(xiàn)場離奇詭異,居然都是意外死亡纹因,警方通過查閱死者的電腦和手機喷屋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來瞭恰,“玉大人逼蒙,你說我怎么就攤上這事。” “怎么了是牢?”我有些...
    開封第一講書人閱讀 165,417評論 0 356
  • 文/不壞的土叔 我叫張陵僵井,是天一觀的道長。 經(jīng)常有香客問我驳棱,道長批什,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,868評論 1 295
  • 正文 為了忘掉前任社搅,我火速辦了婚禮驻债,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘形葬。我一直安慰自己合呐,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,892評論 6 392
  • 文/花漫 我一把揭開白布笙以。 她就那樣靜靜地躺著淌实,像睡著了一般。 火紅的嫁衣襯著肌膚如雪猖腕。 梳的紋絲不亂的頭發(fā)上拆祈,一...
    開封第一講書人閱讀 51,692評論 1 305
  • 那天,我揣著相機與錄音倘感,去河邊找鬼放坏。 笑死,一個胖子當(dāng)著我的面吹牛老玛,可吹牛的內(nèi)容都是我干的淤年。 我是一名探鬼主播,決...
    沈念sama閱讀 40,416評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼蜡豹,長吁一口氣:“原來是場噩夢啊……” “哼互亮!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起余素,我...
    開封第一講書人閱讀 39,326評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎炊昆,沒想到半個月后桨吊,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,782評論 1 316
  • 正文 獨居荒郊野嶺守林人離奇死亡凤巨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,957評論 3 337
  • 正文 我和宋清朗相戀三年视乐,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片敢茁。...
    茶點故事閱讀 40,102評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡佑淀,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出彰檬,到底是詐尸還是另有隱情伸刃,我是刑警寧澤谎砾,帶...
    沈念sama閱讀 35,790評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站捧颅,受9級特大地震影響景图,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜碉哑,卻給世界環(huán)境...
    茶點故事閱讀 41,442評論 3 331
  • 文/蒙蒙 一挚币、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧扣典,春花似錦妆毕、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,996評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至远舅,卻和暖如春闰蛔,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背图柏。 一陣腳步聲響...
    開封第一講書人閱讀 33,113評論 1 272
  • 我被黑心中介騙來泰國打工序六, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人蚤吹。 一個月前我還...
    沈念sama閱讀 48,332評論 3 373
  • 正文 我出身青樓例诀,卻偏偏與公主長得像,于是被迫代替她去往敵國和親裁着。 傳聞我的和親對象是個殘疾皇子繁涂,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,044評論 2 355

推薦閱讀更多精彩內(nèi)容