From 367d420470e6587984f2b6add98d74fbee17ff5c Mon Sep 17 00:00:00 2001 From: KRKeegan Date: Fri, 25 Jul 2014 14:13:45 -0700 Subject: [PATCH] Insteon: Add INI Documenation to mh.ini Much of it was simply copied from the INI section in the Insteon POD documentation Closes hollie/misterhouse#448 --- bin/mh.ini | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/bin/mh.ini b/bin/mh.ini index 369a5d952..ffe2c1857 100644 --- a/bin/mh.ini +++ b/bin/mh.ini @@ -2054,9 +2054,90 @@ eib_errata=2 # Category = Insteon @ These are the states displayed on the tk and web menus -@ French: insteon_menu_states=on,off,normal,eco,plus,moins,plus2,moins2,plus3,moins3,+40,-40,5%,30%,60%,100% +@ French: insteon_menu_states=on,off,normal,eco,plus,moins,plus2,moins2,plus3,moins3,+40,-40,5%,30%,60%,100% +@ The default is off,20%,40%,50%,60%,80%,on insteon_menu_states=off,20%,40%,50%,60%,80%,on +@ This is a deprecated parameter that no longer does anything. +@ It is kept around on the off chance that it may be revived in the future. +@ The default is 10. +Insteon_PLM_max_queue_time=10 + +@ If set to 1, MisterHouse will request the status of all Insteon devices on startup. +@ This is useful for making sure that no devices changed their state while MisterHouse was off. +@ The routine will also check the engine version of each device to ensure that the proper ALDB object is created for them. +@ The default is enabled. Set to 0 to disable. +Insteon_PLM_scan_at_startup=1 + +@ Sets the number of times that MisterHouse will try to resend a failed message. +@ The Insteon specification calls for at least 3, MisterHouse defaults to 5. +Insteon_retry_count=5 + +@ Identifies the port on which the PLM is attached. +@ For example: Insteon_PLM_serial_port=/dev/ttyS4 +Insteon_PLM_serial_port= + +@ Setting this to 1, will enable MisterHouse to use a networked PLM such as the +@ Insteon Hub. This functionality seems fairly stable, but has not been +@ extensively tested. +@ +@ You will also need to set values for Insteon_PLM_TCP_host and Insteon_PLM_TCP_port +@ +@ There are a few quirks when using a networked PLM, they include: +@ +@ The communication may be slightly slower with the network PLM. In order to +@ prevent MisterHouse from clobbering the device it is recommended that you +@ set the Insteon_PLM_xmit_delay to 1 second. Testing may reveal that slightly +@ lower delays are also acceptable. +@ +@ Changes made using the hub's web interface will not be understood by MisterHouse. +@ Device states may become out of sync. (It is possible that future coding may +@ be able to overcome this limiation) +Insteon_PLM_use_TCP= + +@ If using a network PLM, set this to the IP address of the PLM. See Insteon_PLM_use_TCP +Insteon_PLM_TCP_host= + +@ If using a network PLM, set this to the port address of the PLM. Generally, the +@ port number is 9761. See Insteon_PLM_use_TCP +Insteon_PLM_TCP_port= + +@ Sets the minimum amount of seconds that must elapse between sending Insteon messages +@ to the PLM. Defaults to 0.25. +Insteon_PLM_xmit_delay=.25 + +@ Sets the minimum amount of seconds that must elapse between sending X10 messages +@ to the PLM. Defaults to 0.50. +Insteon_PLM_xmit_x10_delay=.50 + +@ Periodically, the PLM will report that it is too busy to accept a message from +@ MisterHouse. When this happens, MisterHouse will wait 1 second before trying +@ to send a message to the PLM. If this is set to 1, downgrades the delay to only +@ .3 seconds. Most of the issues which caused the PLM to overload have been handled +@ it is unlikely that you would need to set this. +Insteon_PLM_disable_throttling=0 + +@ The PLM acknowledges the receipt of a command from MisterHouse with an ACK +@ message. It is very rare for a well functioning PLM to fail to send the ACK +@ message. In many cases, the failure to receive an ACK message from the PLM +@ is a sign that the connection between MisterHouse and the PLM (Serial or USB) +@ has died. +@ +@ This setting defines the number of missed ACK messages that must occur for +@ MisterHouse to deem the PLM connection lost. The number of missed ACK messages +@ must all occur while sending a single Insteon command. So if you want this +@ to do anything, this number needs to be less than or equal to the +@ Insteon_retry_count. Once the number of missed ACK messages occurs, MisterHouse +@ will attempt to reconnect the PLM. For some people, the reconnect routine +@ causes errors, so you may want to test this out by manually pulling the +@ connection cable to the PLM to see how your system will react. +@ +@ By default, this is set to 99, essentially disabling an automatic restart. +@ +@ Note the ACK messages discussed here refer to PLM ACK messages not the ACK +@ messages received from an Insteon device in response to a command. +Insteon_PLM_reconnect_count=99 + ****************************************************************************** # Category = Misc