homebridge-macosx-info
See changelog
homebridge-macosx-info is homebridge plugin for Apple HomeKit, get and return somes systems informations from macOSX computer.
Such as :
- updateTime
- Temperature (C°)
- Fan speed (rpm)
- Uptime
- show how long system has been running
- Load average (%)
- the load average of the system over the last 1, 5, and 15 minute
- Free Mem (Mo)
- Disk avalable (%)
- Users (nb)
- CPU Power consumption (Watt)
You can see below screenshots for illustrate homebridge-macos-info plugin.
Screenshots are taken from the Elgato Eve.app
Exemple of .json data response file
Prerequisites
- Install Homebrew (Homebrew installs the stuff you need that Apple didn’t)
- Install node.js on macOS
- Install Homebridge on macOS
- Install Homebridge Config UI X on macOS (optional)
- Install Eve.app on iOS (for all availables plugin function), or it's possible to used "Home" app, but only on macOSX Majave and iOS (all plugin function aren't availables on this app !)
- Enable NOPASSWD for user in
/etc/sudoers
file
Installation
Used npm tool to install homebridge-macosx-info, and execute the command line below
npm i homebridge-macosx-info
Configuration
STEP 1 : homebridge config.json file
Add this lines in config.json
"accessories": ,
Parameter | Note | Optionnal | value |
---|---|---|---|
accessory |
Name of accessory | No | MacOSXSysInfo |
name |
a human-readable name for your plugin | No | macOSX Info |
file |
.json respons file | yes | default : /tmp/_homebridge-macosx-info.json |
updateInterval |
is time in ms of data update | yes | default : null |
consumption |
true for log CPU Consumption |
yes | default : null |
user |
true for log Users number |
yes | default : null |
Note :
- The
index.js
call<PATH of Node Module>/homebridge-macosx-info/sh/homebridge-macosx-info.sh
shell script. You can find this script in the repository in/src/sh
directory- It's possible that you can change the path of
homebridge-macosx-info.sh
inreadUptime
function onindex.js
script
{ const exec = exec; var script = await ; };
STEP 2 : Adapte "homebridge-macosx-info.sh" file in "src/sh" directory
- You can change path of temporary .json files -> var
JSON_DATA_FILE
- You can change path and option of
check_osx_smc
binary -> varCHECK_OSX_SMC
DIR=$(dirname $0)JSON_DATA_FILE=/tmp/_homebridge-macosx-info.json # path of .json respons file CHECK_OSX_SMC=$DIR/../../bin/check_osx_smc # path of check_osx_smc binary
STEP 3 : Add NOPASSWD entry in your /etc/sudoers
# root and users in group wheel can run anything on any machine as any user root ALL = ALL%admin ALL = ALL<USER> ALL=NOPASSWD: ALL
Note : You must change the user
<USER>
by the user who runhomebridge
in your system
STEP 4 : restart homebridge
Combine the two commands in a terminal to restart homebridge background process
launchctl unload ~/Library/LaunchAgents/com.homebridge.server.plist
launchctl load ~/Library/LaunchAgents/com.homebridge.server.plist
Note : This commands are only avalable for macOS
Todo
- Generate all the measures in a .json file [#3]
- Worked on performance
- Use only sh built-in (no sed & no awk) [#4]
Known bugs
- Uptime error in "homebridge-macosx-info" after more than one day ! [#1]
- Temparature and fan mesures don't work on all Apple mac hardware. Used now
check_osx_smc
binary. You can see the hardware compatibility here [#2]
Credits
- The original HomeKit API work was done by KhaosT in his HAP-NodeJS project
- simont77 - fakegato-history
- Jedda Wignall - OSX-Monitoring-Tools/check_osx_smc
Disclaimer
I'm furnishing this software "as is". I do not provide any warranty of the item whatsoever, whether express, implied, or statutory, including, but not limited to, any warranty of merchantability or fitness for a particular purpose or any warranty that the contents of the item will be error-free. The development of this module is not supported by Apple Inc. or eve. These vendors and me are not responsible for direct, indirect, incidental or consequential damages resulting from any defect, error or failure to perform.
License
This project is licensed under the MIT License - see the LICENSE file for details