Wiki source code of Zummesh Keypad Custom Programming

Version 10.1 by Mark Kohlmann on 2021/08/20 22:19

version	line-number	content
6.2	1	(% class="box warningmessage" %)
	2	(((
8.1	3	Buttons 5 and 6 presently cannot be exposed to ShowRunner and will only work locally. ZUMMESH-KPAV type keypads are not supported with this approach and require an AVBRIDGE.
6.2	4	)))
	5
8.1	6	ShowRunner™ supports receiving button presses from ZUMMESH-KP* keypads. Overriding buttons is done on a per button basis.
5.2	7
	8	Requirements:
	9
	10	* JBOX w/ NETBRIDGE
	11	* ZUMMESH Firmware v1.07.016 or newer
10.1	12	** NETBRIDGE firmware v1.013.0021
	13	** ZUM-KPBATT firmware v0010000113
5.2	14	* NETBRIDGE defined in ShowRunner as a load controller
9.1	15	* ZUMMESH-KP or ZUMMESH-KPBATT (Excludes ZUMMESH-KPAV series keypads are not supported due to lack of firmware support)
5.2	16	* ShowRunner™ 3.004 or newer
	17
8.1	18	Keypads have 6 buttons, 1 through 4 can be exported individually, 5 and 6 are supported by ShowRunner but not Crestron:
5.2	19	[[image:ZUMMESH-KP Buttons.png]]
	20
	21	Keypad definition in ShowRunner config:
	22
	23	##//DeviceConnectionId//## is the KeypadId used to uniquely identify the ZUMMESH-KP. This must be between 1 and 255.
	24	##//DeviceHostId// ##is the IP-ID of the RF Gateway that owns the NETBRIDGE
	25	##//DeviceHostBranch// ##is the RF-ID of the NETBRIDGE on the gateway
	26	##//Model// ##may be the actual keypad model excluding the color and finish. Example ZUMMESH-KP10GBATT-GRY-S is "ZUMMESH-KP10GBATT". "ZUMMESH-KP" or "ZUMMESH-KPBATT" may also be used.
	27
	28	## "7": {
	29	"AreaId": 2,
	30	"LinkedAreaIds": null,
	31	"Id": 7,
	32	"Name": "Zummesh KP",
	33	~ "//DeviceConnectionId//": "1",
	34	~ "//DeviceHostId//": "B0",
	35	~ "//DeviceHostBranch//": 5,
	36	"SerialNumber": "",
	37	"DisableOff": false,
	38	"DisallowDisable": false,
	39	"FlipRaiseLower": false,
	40	"MasterRaiseButtonIndex": 0,
	41	"MasterLowerButtonIndex": 0,
	42	"HoldTime": 0.5,
	43	"DoubleTapTime": 0.5,
	44	"//Model//": "ZUMMESH-KPBATT",
	45	"Enabled": true,
	46	"KeypadType": "A",
	47	"ControllerIds": [],
	48	"DirectLoadIds": null,
	49	"Actions": null,
	50	}##
	51
	52	==== Automatic Setup: ====
	53
6.2	54	This method will automatically enable all buttons to report to ShowRunner™
	55
5.2	56	* Console to ShowRunner
	57	* Obtain the keypad address by querying the devices on the NETBRIDGE:
	58	##sr zummesh show devices [Gateway IP-ID in hex] [NETBRIDGE RF-ID in hex]##
	59	Example: ##sr zummesh show devices B0 1A##
	60	[[image:1626996842264-632.png]]
	61	* Setup the keypad buttons that will report to ShowRunner™:
	62	##sr zummesh keypad custom buttons [Gateway IP-ID] [NETBRIDGE RF-ID] [Keypad Address] [Keypad Id] [List of Buttons to Override Local Logic, comma/dash separated list]##
6.2	63	Example: ##sr zummesh keypad custom buttons B0 1A 52E5 1 1-6##
5.2	64	[[image:1626997279912-938.png]]
	65
	66	==== Manual Setup: ====
	67
6.2	68	Use this setup method if you wish to assign specific ShowRunner™ button IDs to ZUMMESH-KPs or selective send buttons to ShowRunner™
	69
5.2	70	* Connect to RF Gateway console
6.2	71	* ##RFRCON [NETBRIDGE RF-ID] DISPLAYDEVICES## to obtain the Addr of the Keypad
5.2	72	[[image:1626997350133-604.png]]
6.2	73	* Calculate Button IDs:
	74	Keypad IDs are 1 to 255
	75	Button Numbers are 1 to 6
	76	Tap Action is 0
	77	Hold Action is 1
	78	Release Action is 2
	79	ExportId = (Keypad ID << 8) + (Button Number << 4) + ButtonAction
	80	Example for keypad id of 2 button 2 w/ hold action
	81	##(2 << 8) + (2 << 4) + 1 = 545 or 221h##
	82	Example for keypad id of 128 button 5 w/ tap action
	83	##(128 << 8) + (5 << 4) + 0 = 32848 or 8050h##
	84	* Send command per button to enable reporting:
	85	##rfrcon [NETBRIDGE-RFID] setbuttfunc [KEYPAD ADDRESS] [ButtonNumber] 22 [Tap-ExportID in hex] [Hold-ExportID in hex] [Release-ExportID in hex]
	86	rfrcon 03 setbuttfunc 52E5 2 22 220 221 222##
	87	[[image:1626997728072-241.png]]