richierockskool/homebridge-inkbird-wifi-gateway

homebridge Inkbird wifi gateway

homebridge-inkbird-wifi-gateway

A homebridge-plugin for the Inkbird bluetooth pool temperature sensors using the Inkbird Wifi Gateway.

Features:

• Temperature

• Battery level

• Wifi Gateway IBS-M1S

• Supported sensors:

  • IBS-PO1/B

  2. Update homebridge configuration file.

  {

        "name": "Inkbird Wifi Gateway",
        "host": {
        "title": "IP Address / Hostname",
        "type": "string",
        "required": true,
        "format": "hostname"
   },
         "mac_address": {
         "type": "string",
         "title": "Bluetooth MAC address for sensor (xx:xx:xx:xx:xx:xx). If empty, then first sensor to be found will be used - see log for MAC found.",
         "required": false
  

  }, "devices": [ { "name": "InkbirdWifiGateway", "type": "IBSM1S", "deviceId": "<>" } ], "update_interval": 15, "storage": "filesystem", "loglevel": 3, "platform": "homebridge-inkbird-wifi-gatewway" }

- name            (required): Choose a suitable name for your sensor accessory.
- model           (required): Choose a type from list of supported types above.
                              If your type is not available, but you want to try if your sensor works anyway put
                              `not in list - try it anyway`
                              You won't get an error that the sensor is wrong and plausibility and CRC checks will be switched off.
                              But be warned, you might get very strange values!!!
- mac_address     (optional): Put the MAC-address of the sensor if you know it.
                              If not, leave the value open and the plugin will choose any sensor it finds that passes the plausibility checks. In the log you will get a message like this:
                              `6/6/2022 12:39:05 [Inkbird Wifi Gateway]
                              There you have your MAC. Copy it to your configuration in this format ("xx:xx:xx:xx:xx:xx") to lock only to this sensor.
- update_interval (optional): If you specify an update interval (in seconds) the plugin will automatically refresh the values so you have
                              a faster response for your value. Also you need to configure this option, if you want the Inkbird history to be
                              filled with values. But be advised that this might reduce your batteries lifetime, so don't choose it too short.
- storage         (optional): Where do you want the Eve history to be stored (`filesystem` (default) or `googleDrive` (not tested)).
- loglevel        (optional): The log level at start of the plugin - smaller numbers lead to less messages
                              (0 = Fatal, 1 = Error, 2 = Warning, 3 = Info (default), 4 = Debug).

homebridge-inkbird-wifi-gateway's Issues

Plugin not installing

While installing following NPM error is produced-
npm ERR! code ENOENT
npm ERR! syscall spawn git
npm ERR! path git
npm ERR! errno -2
npm ERR! enoent An unknown git error occurred
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:
npm ERR! /home/homebridge/.npm/_logs/2022-07-21T13_00_26_460Z-debug-0.log

Operation failed. Please review log for details.

Logs:

Show the Homebridge logs here, remove any sensitive information.

Plugin Config:

Show your Homebridge config.json here, remove any sensitive information.

Screenshots:

Environment:

• Plugin Version:
• Homebridge Version:
• Node.js Version:
• NPM Version:
• Operating System:
  OS - Ubuntu

Failed to load plug-ins config schema

Describe Your Problem:

Logs:

Show the Homebridge logs here, remove any sensitive information.

Plugin Config:

Show your Homebridge config.json here, remove any sensitive information.

Screenshots:

Environment:

• Plugin Version:
• Homebridge Version:
• Node.js Version:
• NPM Version:
• Operating System:

Update package.json Build and Lint #9

What is the proper way to fix these Updates, do you go back to the one highlighted in Red Or Green? What is it telling you to do when this happens

Run errors and how to fix them

{
"private": false,
"displayName": "Homebridge Inkbird WiFi Gateway",
"name": "homebridge-InkBirdIBS-M1",
"author": "R.Jagger",
"version": "1.0.0",
"description": "Control Inkbird BT devices through the WiFi Gateway App",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "git://github.com/richierockskool/homebridge-InkBirdIBS-M1.git"
},
"bugs": {
"url": "https://github.com/richierockskool/homebridge-InkBirdIBS-M1/issues"
},
"engines": {
"node": ">=14.18.1",
"homebridge": ">=1.3.5"
},
"main": "dist/index.js",
"scripts": {
"lint": "eslint src/**.ts --max-warnings=0",
"watch": "npm run build && npm link && nodemon",
"build": "rimraf ./dist && tsc",
"prepublishOnly": "npm run lint && npm run build"
},
"keywords": [
"homebridge-plugin"
"WiFi"
"bluetooth",
"temperature",
"sensor",
"Inkbird",
"IBS-M1",
"homebridge"
],
"dependencies": {},
"devDependencies": {
"@types/node": "^16.10.9",
"@typescript-eslint/eslint-plugin": "^5.0.0",
"@typescript-eslint/parser": "^5.0.0",
"eslint": "^8.0.1",
"homebridge": "^1.3.5",
"nodemon": "^2.0.13",
"rimraf": "^3.0.2",
"ts-node": "^10.3.0",
"typescript": "^4.4.4"
}
}

**Plugin Config:**

```json
Show your Homebridge config.json here, remove any sensitive information.

Screenshots:

Environment:

• Plugin Version:
• Homebridge Version:
• Node.js Version:
• NPM Version:
• Operating System:

Provide valid configuration example

Describe Your Problem:
Hi,

I really appreciate that someone works on integration for inkbird wifi gateway.
What I would really appreciate is working example with description what to change where for combination of devices IBS-M1 (2gen) + IBS-PO1/B. I am stucked with non working configuration and honestly I don't understand how to define it.

Sample contains invalid json with object in object without key or array. It contains only part of fields and there is no mention which mac address to use where (BLE mac of sensor or wifi mac of GW?) or where to find device ID, how to add accessories etc....

Please, look at the samples and update it to be clear.

Thank You

Inkbird Wifi Gateway is not showing up in the accessories on Homebridge or HomeKit

Failed to load plugins config schema

npm install -g homebidge-inkbird-wifi-gateway

Expected behavior:
Inkbird Wifi Gateway shows up in Homebridge and HomeKit

Show the Homebridge logs here, remove any sensitive information.
``[homebridge-inkbird-wifi-gateway] Initializing homebridge-inkbird-wifi-gateway platform...`

**Plugin Config:**

```json
Show your Homebridge config.json here, remove any sensitive information.

"platforms": [
   {
      "platform"       : "HomebridgeInkbirdWifiGateway",
      "plugin_map"      :
      {
         "plugin_name": "homebridge-inkbird-wifi-gateway",
         "index": 0
      },
      "name"            : "Homebridge Inkbird Wifi Gateway",
      "model"           : "IBS-M1S",
      "mac_address"     : "e8:db:84:b6:9c:e6",
      "update_interval" : **15**,
      "storage"         : "filesystem",
      "loglevel"        : 3

Screenshots:

[Environment: HomeKit

• Plugin Version:1.07
• Homebridge Version: 1.61
• Node.js Version: 18.16.0
• NPM Version: 9.6.5
• Operating System: macOS
• Errors
• hb-service -->](dir: /usr/localCMD: npm install -g [email protected] ERR! code 236npm ERR! git dep preparation failednpm ERR! command /usr/local/bin/node /usr/local/lib/node_modules/npm/bin/npm-cli.js install --force --cache=/Users/richjagger/.npm --prefer-offline=false --prefer-online=true --offline=false --no-progress --no-save --no-audit --include=dev --include=peer --include=optional --no-package-lock-only --no-dry-runnpm ERR! npm ERR! code ENOTDIRnpm ERR! npm ERR! syscall renamenpm ERR! npm ERR! path /usr/local/lib/node_modules/homebridge-inkbird-wifi-gatewaynpm ERR! npm ERR! dest /usr/local/lib/node_modules/.homebridge-inkbird-wifi-gateway-4ACtSijXnpm ERR! npm ERR! errno -20npm ERR! npm ERR! ENOTDIR: not a directory, rename '/usr/local/lib/node_modules/homebridge-inkbird-wifi-gateway' -> '/usr/local/lib/node_modules/.homebridge-inkbird-wifi-gateway-4ACtSijX'npm ERR! npm ERR! npm ERR! A complete log of this run can be found in: /Users/richjagger/.npm/_logs/2023-05-08T20_32_50_368Z-debug-0.lognpm ERR! A complete log of this run can be found in: /Users/richjagger/.npm/_logs/2023-05-08T20_32_41_507Z-debug-0.logOperation failed. Please review log for details.)

npm install failing on macOS

A continuation of nodejs/node-gyp#2852

@richierockskool Please try the following commands on your Mac and paste the results here...

1. ls -hal ~ | grep node_modules
2. ls -hal ~/.npm-packages/lib | grep node_modules
3. ls -hal ~/.npm-packages/lib/node_modules | grep inkbird
4. ls -hal ~/.npm-packages/lib/node_modules | grep rename

It is strange that on my Mac, my node_modules are in ~ and on yours they are in ~/.npm-packages/lib

IBS-M2 compatibility

Good morning,
Thank you for your work, do you think you can make the plugin compatible with the IBS-M2 connected module?
THANKS

Trouble configuring Plugin with HOOBS

Hi!

Thanks again for your effort, I was finally able to install your plugin (v1.2.1) in my HOOBS Box.

But the issue now I that I can't seem to configure it as mentioned in your instruction.

If I go to the Advanced settings of your plugin in HOOBS, this is what I can see...

I can't find where am I supposed to enter my IBS-M1S Hub IP address.

Thanks again for all your efforts!

Does this work with the new pool temperature sensor - IBS-PO2R-O?

Describe Your Problem:
Trying to get this to work on my Homebridge install but no luck so far

Logs:

I see the plugin registers, but then nothing more is visible in my logs
[29/06/2023, 10:47:36] Registering platform 'homebridge-inkbird-wifi-gateway.homebridge-inkbird-wifi-gateway'

Plugin Config:

Show your Homebridge config.json here, remove any sensitive information.

Screenshots:

Environment:

• Plugin Version:
• Homebridge Version:
• Node.js Version:
• NPM Version:
• Operating System:

Installation on HOOBS get stuck

Hi,

I really don’t know much about how things are working when you install a plug-in in either HOOBS or any other HomeBridge service, but I have installed a lot of plug-ins and they were all installed fine, but yours get stuck in the installation process.

I hope you’ll be able to help, I’m really looking forward to use your plug-in.

Thanks

Same, to fix the problem, just edit the `main` property in `package.json` from `index.js` to `src/index.js`.

Same, to fix the problem, just edit the main property in package.json from index.js to src/index.js.

EDIT: The issue has been fixed in the repo, the author just needs to push the latest version to npm.

Originally posted by @HonbraDev in tonesto7/homebridge-smartthings#431 (comment)

Problems getting Homebridge recognize the plugin

This is a Homebridge plugin to hook into the Inkbird Gateway that I am trying to get working,
I keep get this message...No plugin was found for the platform "homebridge-inkbird-wifi-gateway" in your config.json. Please make sure the corresponding plugin is installed correctly.
Here is my config.json
"platform":"HomebridgeInkbirdWifiGateway",
"name": "homebridge-inkbird-wifi-gateway",
"model": "IBS-M1S",
"mac_address": "e8:db:84:b6:9c:e6",
"ip": "99.228.220.201",
"update_interval": 600,
"storage": "filesystem",
"loglevel": 3

Homebridge Verification

Gonna close your issue in the verified repo for now, and start one here, so that a new issue can be created in the verified repo once the plugin is ready.

[9/8/2023, 2:13:13 PM] No plugin was found for the platform "HomebridgeInkbirdWifiGateway" in your config.json. Please make sure the corresponding plugin is installed correctly.

[9/8/2023, 2:13:13 PM] No plugin was found for the platform "HomebridgeInkbirdWifiGateway" in your config.json. Please make sure the corresponding plugin is installed correctly.