Wiki source code of Zummesh Keypad Custom Programming

Last modified by Mark Kohlmann on 2026/05/29 20:10

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