Skip to content

Latest commit

 

History

History
173 lines (132 loc) · 7.07 KB

AdvancedTroubleShooting.md

File metadata and controls

173 lines (132 loc) · 7.07 KB
Raw

Homebridges-cmd4 - Advanced Trouble Shooting.

Table of Contents

About Advanced Trouble Shooting

    Unlike Basic Trouble Shooting, this guide is more for those who are having problems with their own scripts and what problems can arise when integrating them with Cmd4.

The #1 Thing to Remember

    Cmd4 runs your script in the background WITHOUT ANY ENVIRONMENT defined. Any variables, alias, special paths are not seen by your script so even if you run the script from the command line and it works, it may not from within Cmd4. Create a bash session without any environment set up like Cmd4 does with the command:

   *SHELL*> env -i bash --noprofile --norc

    From within this environment test your script like:
   *SHELL*> node .homebridge/YourScriptHere.js Get My_Fan On

The Parameters Sent by Cmd4

    The second most important thing to remember is what Cmd4 sends for Get/Set requests. Your script must meet these requirements. These are defined as:

   Get < Accessory Name > < Characteristic >
   Set < Accessory Name > < Characteristic > < Value >

Troubleshooting your own scripts

Execute your script from the command line interface for Get

    Remembering that Cmd4 executes your script in a No environment setting. First execute your scripts from the CLI.

*SHELL*> env -i bash --noprofile --norc
*SHELL*> <your script path> Get < Accessory Name > < Characteristic >

The script must output a one word answer or multiple quoted words.
Note: Your script must also exit with a 0 return code.
### Execute your script from the command line interface for *Set*    Your script must respond to the Set command.
   *SHELL*> env -i bash --noprofile --norc
   *SHELL*> <your script path> Set < Accessory Name > < Characteristic > < value >

Note: Your script must also exit with a 0 return code.

Debug mode is your best friend

    As with Basic Troubleshooting, if your script passes at the CLI, run homebridge in debug mode:
    New in Cmd4 v4.0.0 is how to enable Debug mode. The logs are 100% the same, except that now that Cmd4 has its own logging system ( Copied from Homebridge for compatability ); Enabling Debug logs will not enable Debug logs in other plugins.
There are two ways to enable Cmd4 Debug logs.

Method 1. Modifying the Cmd4 Platform section

    The Cmd4 Platform section can contain the enable Debug directive.

   {
      "platform": "Cmd4",
      "name": "Cmd4",
      "debug": true
   }

Method 2. Add DEBUG environental variable

   *SHELL*> DEBUG=Cmd4

Note: For Homebridge-config-ui-x, you only need to write Cmd4 in the Environmental variable section.

Create a middleWare shell script

    To see when and what both Cmd4 is sending/receiving as well as what your script is sending and receiving, create a middleWare.sh script that is called from the config.json and then calls your script. A script similiar to:

#!/bin/bash
echo $( date ) >> /tmp/Cmd4.log
echo $* >> /tmp/Cmd4.log
node .homebridge/Cmd4Scripts/State.js $* 2>&1 | tee -a /tmp/Cmd4.log

Running a "tail -f /tmp/Cmd4.log" in a seperate terminal window will show you everything that is going on between the processes.

Debugging Fakegato history

See fakegato-history

    if you have added fakegato history, but no history is showing, there are things you can check.

Step 1. Check that the characteristic is polled.

    Only polled characteristics are recorded. For history to be collected you will have to enable polling and interval for the accessory, and according to the fakegato-history documents it should be less than 10 minutes (600 seconds). The new polling config section allows for each characteristic to be polled at their individual times. Check your config.json for this setup. An example of polling is:

"polling": [{"characteristic": "currentHeatingCoolingState",
             "interval": 540,  "timeout": 4000},
            {"characteristic": "currentTemperature",
             "interval": 60,   "timeout": 4000}
           ],

Step 2. Check the fakegato logs.

    The storagePath stores the history records. If there are no logs, run Cmd4 in Debug mode to see if the records are being created.

Step 3. Check your fakegato configuration.

    In the following configuration, the value polled for the characteristic "currentTemperature" will be used for the designation "currentTemp". Similarly the value polled for the characteristic "targetTemperature" will be used for the designation "setTemp". This follows the fakegato-history spec and this model is used for the other fakegato-history records.

"fakegato":{"eve":"thermo",
            "currentTemp": "currentTemperature",
            "setTemp": "targetTemperature",
            "valvePosition": "0",
            "storage": "fs",
            "storagePath": ".homebridge/FakegatoStorage",
            "folder": "folderName",
            "keyPath": "/place/to/store/my/keys/"
           }

Note: The value "0" should be used for any characteristics value which is not possible to retrieve.

Missing icons

   IOS 14 added a new category characteristic to give a hint to any GUI of which icon to use. The big impact was found in missing icons for Televisions. For Televisions you must add:

"category": "TELEVISION"

This category only takes effect for Platform Accessories.

Child process error message

    If you happen to see this error message:

  Error: Command failed: /homebridge/Server.sh Get 'Server' 'On'

    at ChildProcess.exithandler (child_process.js:297:12)
    at ChildProcess.emit (events.js:193:13)
    at maybeClose (internal/child_process.js:1001:16)
    at Process.ChildProcess._handle.onexit (internal/child_process.js:266:5)
  killed: true
  code: null
  signal: SIGTERM,
  cmd: "/homebridge/Server.sh Get Server On"

The command may not exist, but also the timeout value in your config.json for that accessory may be too low.

License

See LICENSE