hass指定版本_【RouterHook】支持HASS和IFTTT的事件回调器

本帖最后由 囍冯总囍 于 2020-4-17 16:56 编辑

2020/04/17 重大更新！升级1.0版本，支持HASS等！欢迎加入抠抠群：玖 伍 玖叁柒陆捌 壹壹

目前已经提交上架ARM384和HND软件商店啦！其他平台暂不打算支持啦(380官方停更了都，有需要的自己改代码吧)

本插件基于ServerChan插件改版而来。基本上就是变更了一下ServerChan的请求地址、消息格式由Markdown改为JSON并修复了一些小小的BUG。

理论上支持局域网服务地址的回调(未测试)

若收不到回调内容或回调body为空请及时反馈(没有进行完全测试，多半是因为生成的json格式有问题导致jq无法匹配，导致body为空)

项目开源在github上，可以先下载离线包安装体验哦。

插件通过POST你的回调地址，body中为序列化的json内容，具体消息格式参看项目说明即可

路由器端的WebHook插件，方便路由器将消息通知回调到你配置的URL。

感谢缘起

身为一个资(zhuang)深(bi)程序员，ServerChan显然是满足不了我的要求的。因为ServerChan只是提供了一个通知推送的工具，但是如果我想用企业微信机器人呢？ServerChan显然满足不了要求哇。其实ServerChan还有一款可以进行【1对多】推送的PushBear和具有【双向交互】功能的TalkAdmin产品，都灰常好用！但毕竟这样支持的平台削微单一，不是那么有普适性，单独为他们开发插件远远超出了我的能力范围。为了方便同行们可以用自己熟悉的语言和环境，与路由器之间可以更进一步的交流(资深程序员不一定有空开发路由器插件不是)，这个插件就诞生啦！不过说白了这个插件还是只是一个单向推送，没有实现被回调(貌似固件有WebAPI？没研究过，那个也超出了我的能力范围，暂时不管了)这是我滴第一个作品，第一次接触shell和插件开发，所以基本就是些小修小改，踩了很多坑，也没有进行完善的测试，所以如果使用中有什么问题请即时反馈。

由于原ServerChan插件停更了，考虑到企业微信机器人也是用MarkDown消息的，可以考虑后续在ServerChan插件上增加企业微信甚至钉钉机器人的支持(如果你是个程序猿，有了本插件，剩下的你直接自己实现得了)插件说明

在网上找了些图解实WebHook的，大体一个意思吧，并不是对此插件的详细解释，但是技术上是相类似的。简单的说就是和ServerChan一样配置了类似的功能开关后，路由器就会在定时、设备上线、重拨等事件发生时，自动将你需要的内容组织成JSON格式的数据POST到你配置好的回调URL们中。

例如： 下面这个图，webhook图标下方可以理解为路由器的内部处理逻辑，下方出现事件触发后，通过本插件将数据消息推送到最上面的那些云端或本地服务中。这里的云端服务可以是你自己的服务器搭建的Web服务、可以是利用现在时下流行的无服务器计算搭建的云函数(例如腾讯云的SCF啦、百度云的函数计算啦、或者LeanCloud啦)

webhook-1.png (69.51 KB, 下载次数: 23)

2020-3-23 08:59 上传

再如： 下面这个图，正好有个路由器(这么巧)，然后那个IXON云理解为本插件就好了，嗯嗯。

webhook-2.jpg (82.42 KB, 下载次数: 16)

2020-3-23 09:00 上传也就是说，这个插件只是负责把通知消息发送到你自己的服务上，而服务的逻辑需要自己去实现哦！所以对于小白来说可能不太适用(因为这个是需要开发后台服务的)那有个啥用呢？具体例子见下方说明。使用方法软件中心安装

配置回调URL(这里没做验证、任何校验和任何处理，你填写的URL将被原封不动的请求，也就是说http://或者https://这种不能省略，后面的路径和参数你也可以直接填写)

配置好下方的消息内容开关

通过点击手动推送按钮可以进行手动消息推送

如果没啥bug的前提下，你配置的URL列表们就会依次收到路由器的消息回调了，具体的消息格式见下方

服务器端收到的POST消息中body就是JSON序列化后的字符串，你需要进行反序列化哦(例如JSON.parse(body))

目前触发类事件(网络重拨或客户端上线)已适配IFTTT官方的WebHook接口

1.0版新增了三个动态参数和自定义Header功能，具体可见下方说明

1.0版新增了虚拟传感器功能，将路由器的部分参数作为传感器接入HASS中，从而可以更完美的配合智能家居使用

应用举例接入HASS实现智能家居联动

1.0版本加入了HASS对接功能，只需要按照HASS官方的HTTP SENSOR说明配置好回调地址，配置好鉴权的Header，就可以实现路由器状态或客户端状态更新到HASS中。比如说：路由器CPU温度过高后HASS中场景控制散热器散热、白名单设备上线后控制回家场景等等

通过IFTTT实现丰富功能

由于触发类事件以支持IFTTT的WEBHOOK功能，所以只需按照上述内容配置好你的IFTTT回调地址，即可在事件发生时触发IFTTT中的逻辑：比如给你手机打电话、发短信、推送消息、发邮件等等。

自定义DNS解析

目前软件商店里面的DDNS解决方案应该很全了，基本上常用的DDNS都可以支持啦。但是如果你用的恰巧没有在列呢？有了本插件也可以搞定！插件可以在IP变动后回调你的服务，你只需要在服务里实现对接你的DNS的API修改对应的解析记录就可以啦！因为支持IPv4和IPv6，所以属实灰常方便！

钉钉、企业微信机器人通知

有了此插件，你就可以实现钉钉、企业微信机器人的通知推送啦(这部分逻辑当然要自己实现，自己搭建后台服务)，这样你就可以在有设备上线时(比如你老板的设备上线了，但人可能还没来哦)，收到通知推送啦！网络重拨后更新防火墙规则

有了此插件，当你的路由器重新拨号后(如果你用的也是PPPoE拨号完了会随时变动外网IP那种)，此插件会回调你的地址，这样你就可以更新云端的防火墙策略、安全组策略，实现只允许你当前IP进行SSH登录、MySQL登录等限制，提升云服务的安全性手机连上路由器智能家居实现回家场景联动

目前貌似只有设备上线的通知推送(下线的没有噻？)，所以可以实现你即将到家的时候，手机已经连上你家的WIFI啦，这样插件可以回调你的局域网或云端的HA网关或者IFTTT这种，实现一系列的场景联动。1.0版本后加入了设备上下线状态推送功能。在名单中配置好MAC地址列表，则每一个mac代表一个虚拟设备，设备的上下线状态会同步推送到你的后端。同时支持聚合设备功能，即将多个mac聚合为一个统一的虚拟设备(支持两种聚合模式)，则可以实现当有一个设备上线时聚合设备为开，所有设备下线时聚合设备为关的功能。路由器温度高自动打开风扇降温

通过设置定时推送(有路由器的设备温度信息)，当路由器温度高时，你的后台服务可以直接控制风扇进行路由器降温(当然这个后台服务你需要自己去实现)，目前通过IFTTT或HASS都可以实现，最短可实现1s更新一次数据(可能对路由器负载过大，推荐设置的长一点儿)Tips:开发过程中发现，若软件中心首页显示更新中...，多半是因为dbus挂了，目前不知道除了重启路由器怎么能够单独重启dbus服务。

/routerhook/version文件中若版本号后面有换行，则会导致插件安装后，接口http://xxx/_api/routerhook_返回的JSON格式异常，导致软件中心界面更新中...

原ServerChan插件使用VSCode编辑install.sh和uninstall.sh的时候保存后会导致无法执行，提示no such file or directory，用记事本重新保存一下即可(可能是编码问题但我也没搞清楚，如果你遇到类似问题希望对你有帮助)Windows下的打包命令：貌似build.sh是可以进行打包的，但是具体怎么用我也不知道(看代码应该是需要拷贝到路由器上运行然后就可以打包啦？还请大神指点)

打包：在routerhook根目录打开gitbash，输入tar -czvf routerhook.tar.gz routerhook/即可

解压：解压命令：tar -xzvf routerhook.tar.gz -C /目标地址软件中心相关：重置软件中心命令：SSH登录路由器后koolshare-reset，此操作会清空所有插件

查看软件中心运行：ps|grep httpdb|grep -v grep，有就说明有进程运行哈

停止软件中心命令：sh -x /koolshare/perp/perp.sh stop

启用软件中心命令：sh -x /koolshare/perp/perp.sh start

重启路由Web页面服务: service restart_httpd

定时任务相关

cru定时命令add:  cru a delete:  cru d list:  cru lmin      分钟(0-59)hour     小时(0-24)day      日期(1-31)month    月份(1-12；或英文缩写Jan、Feb等)week     周几(0-6，0为周日；或单词缩写Sun、Mon等)每间隔多久用[*/数字]表示例1：周三的凌晨5点重启cru a Timer_ID1 "0 5 * * 3 /sbin/reboot"例2：每隔5天的凌晨3点重启cru a Timer_ID2 "0 3 */5 * * /sbin/reboot"例2：每隔5分钟重启cru a Timer_ID3 "*/5 * * * * /sbin/reboot"例4：删除定时器Timer_ID3cru d Timer_ID3例5：显示所有定时器列表：cru l

POST数据格式：

如不手动指定，则Header中content-type默认为application/json(手动指定管不管我也没测试)

具体格式请直接去GITHUB参看README吧，论坛里面发太麻烦了！

关于动态参数：

支持在配置的URL和Header时添加动态参数，系统在发送请求前会先将URL和Header中的动态参数进行字符串替换_PRM_EVENT：替换为当前消息的消息类型，如ifUP,newDHCP,cronINFO,manuINFO等

_PRM_DT：替换为当前时间的GMT标准时间串，形如Wed, 15 Apr 2020 08:59:50 GMT

_PRM_TS：替换为当前时间的10位时间戳(与_PRM_DT并非相等，存在毫秒的差异)例如1：

HASS的回调地址中需要指定设备名，格式形如：http://IP_ADDRESS:8123/api/states/sensor.DEVICE_NAME，则你只需要在配置这个回调地址的时候，将DEVICE_NAME写作为_PRM_EVENT，即你填写的回调地址为http://IP_ADDRESS:8123/api/states/sensor._PRM_EVENT，系统在请求该地址时候，会将_PRM_EVENT替换为当前消息的msg_type的内容，比如上面的manuINFO啦，rh_load啦等等例如2：

HASS的回调中需要在请求头配置鉴权签名，则直接将长期签名配置到对应的自定义请求头中去即可。但如果需要有当前时间等之类的参数时候，你只需要用_PRM_TS或者_PRM_DT代替即可，系统在发送请求前会自动将其替换为对应的内容关于虚拟传感器功能

很多小伙伴可能想要实现实时性较高的数据回调，比如想几秒钟就获取一次CPU温度啦之类的。所以才有了这个功能和1.0版本的诞生(不然可能也就是万年0.X了)

虚拟传感器功能是根据坛友提出来的想法和提供的HASS的文档而实现哒！当然这个过程中踩了很多坑(超多，不想说)

目前支持的功能说明如下：推送地址列表

考虑到可能有人需要使用多种回调，有的地址是接入HASS的，有的地址是接入其他后台服务的，有的地址是接入IFTTT的，那么可以把这些地址都配置进去后，在此设置需要以HASS格式推送消息的地址列表。 比如你配置的URL列表如下：你自己的回调地址

你自己搭建的外网服务的回调地址

局域网中的HASS回调地址

互联网上的IFTTT回调地址

那么现在如果你只想让虚拟传感器消息推送第三个地址，则只需要在此填入3即可，如果是3和4，则填入3,4用符号分割即可触发间隔

配置多少秒上报一次数据，这里对数据格式有一定要求，必须≤60秒且数字可以被60整除，比如1，2，3，4，5，6，10等等

建议配置的稍微长一点儿，比如10秒啊，30秒啊，否则不知道会不会增加路由器负载(我反正没测试，爆了不赖我)聚合设备

设备上线状态为ON，离线状态为OFF，聚合设备是将列表中所有设备状态按照指定模式进行聚合后的新设备(设备名为rh_dev)【或模式】只要有一个设备在线，则聚合设备状态为ON；当所有设备离线后聚合设备状态为OFF

【与模式】必须所有设备都在线，则聚合设备为ON；否则为OFF

用处是啥呢？比如说：

你们家两口人有两个手机，你事先配置好了两个手机的mac地址，且每60分钟进行一次状态上报到HASS中。则每个手机都会是一个虚拟设备，设备名为rh_dev_mac地址这时候如果你想要实现当有一个人回家时就执行回家场景，所有人都离家后执行离家场景的话，你可以使用或模式。这时候会有一个新的虚拟聚合设备，名为rh_dev，其对应的设备状态便是ON或者OFF