Wiki source code of Zummesh Keypad Custom Programming

Version 12.1 by Mark Kohlmann on 2024/04/05 19:46

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