This document could not be shown here. Open the PDF.
Text of this document24 pages · 3,141 words
Page 1
RK-HUB RakoWireless Ethernet Hub 2024 Version 1.4.6
Page 2
For programming a wireless system: Wireless Module Programming Guide or Wireless RAK Programming guide Contents: 1Functions of the RK-HUB 2Installing the RK-HUB 3Discovering the HUB and Setting the House Number 3.1 Discovering the HUB 3.2 Setting up the HUB using the Webpage Wizard 3.3 Managing the HUB House number 3.4 If you cannot connect to the HUB 4Linking the HUB for cloud services 4.1 Where to find each cloud service 4.2 Linking the HUB to Cloud services 5AddingtheHUBasadevicetoRasoftPro 6Uploading the project file 7Downloadingtheproject file 8Events 8.1 Setting Events using Rasoft Pro 8.2 Setting Events using the Rako App 9Activities 9.1 Setting Events Using Activities 9.2 Setting Audio Activities 10Mappings 10.1 Mapping wireless commands to give multi-room functionality 10.2 Triggering Macros from Maps 11Macros 11.1 Writing Macros 11.2 Triggering Macros 12Holiday Mode 13CustomStrings 13.1 ASCII Custom Strings 13.2 Port Number 13.3 TCP 13.4 UDP 13.5 HTTP 14UpgradingtheHUB 15UDPFeedback 15.1 Live feedback 15.2 UDP feedback log 15.3 HUB webpage logs 16Activity States RK-HUB Manual Version 1.4.6
Page 3
1Functions of the RK-HUB TheRK-HUBwilladdthefollowing features to a Rako wireless system: - Network interface: Local Programming, App control and IP integration of 3rd party control systems. - Cloud Gateway: Interfaces with Amazon Alexa, Google Home, Apple Homekit, Sonos etc. - Storing Project file information: Room, Channel and Scene information can be stored. - TimedEvents: Automatic functions at fixed times including dawn & dusk. - Mapping: Commandscanberedirectedtoperformothertasks. - Macros: A series of commands that are triggered by a single command or event. Specific steps can be enabled and disabled giving conditional functionality. - Holiday Mode: Replays recorded system activity, creating an occupied appearance to a property. 2Installing the RK-HUB - Step 1: Plug DC power supply into RK-HUB and available 13A socket. - Step 2: Plug the Ethernet patch cable from the RK-HUB to a spare port in a router or network switch. - Step 3: Mount the RK-HUB to a wall using the fixing plate if required. RK-HUB Manual Version 1.4.6
Page 4
3Discovering the HUB and Setting the House Number Before proceeding with any programming, the HUB needs to be discovered and the House numberset. This is done via a webpage setup wizard. 3.1 Discovering the HUB OpenRasoftProprogrammingsoftware. Ensure that the laptop is connected to the same network as the HUB. TheHUBshouldappearinthe“Communication”windowin the bottom right of the software with a red stop sign. If it does not appear, press "Refresh.” If it still does not appear, refer to Section 3.4 of this manual. RK-HUB Manual Version 1.4.6
Page 5
3.2 Setting up the HUB using the Webpage Wizard Asafinalcheck, it is advisable to disconnect and reconnect to the HUB by double-clicking the HUB: If no pop-up box appears, then the HUB House number and Project File House number are the same. RK-HUB Manual Version 1.4.6
Page 6
To access the HUB webpages, right-click the communication device in the bottom-right corner of the software. Select “Open in Browser.” - - Step 1: On the Welcome page, select “Next to begin setup.” - Step 2: Set a password; this will be used to login to the webpages. It will also be the password used to login to the App if a password is needed. - Step 3: Sets the House number of the HUB and therefore system. This should be set to match the Rasoft Pro project file as defined in the “New Project Wizard.” - Step 4: Select “Finish” to complete setup. 3.3 Managing the HUB House number Leaving the HUB at the default House address of 1 is strongly discouraged. Leaving the Housenumberat1drastically increases the likelihood of interference from nearby Rako systems. RK-HUB Manual Version 1.4.6
Page 7
TheHUBalwayshasadefaultHouseAddressof1,ifithasnotbeensetupbefore.Before programming using the HUB, it is important to ensure the HUB House number corresponds to the Project File House number. ChangetheHousenumberiftheHUBhasalreadybeensetupasdescribedin3.2. Seebelow: WARNING If a pop-up box appears with a warning about the House number, click "Cancel.” Do not continue programming; this means there is a conflict between the “Project File House Number”andthe“HUBHouseNumber.” 3.4 If you cannot connect to the HUB If the software cannot connect to the HUB, first restart the software and ensure that it is fully updated. If the HUB still does not appear, it is most likely a networking issue. If this problem cannot be solved, then the HUB can be connected point-to-point using a standard Ethernet cable. 4Linking the HUB for cloud services To be able to access cloud services, the HUB must be linked to a my.rakocontrols.com account. 4.1 Where to find each cloud service Somecloudservices are configured and customised from the HUB webpage, whereas others are from my.rakocontrols.com HUBwebpage:SonosActivities (new cloud API and “ACM” style custom IP strings) including custom and default templates (RCM/WCM-audio style keypads) my.rakocontrols.com: Amazon Alexa, Google Home and Apple Home including “Custom Scenes” and advanced apple Home configuration (Channel and Room mode etc.) NB Moredetailed descriptions of how to use the advanced settings within the cloud services are linked from the relevant section of either the HUB webpages or my.rakocontrols.com 4.2 Linking the HUB to Cloud services This is linked via the HUB webpages; navigate to the “Cloud” section from the menu on the right-hand side of the screen. This will open a page, as below: - Step 1: Press "Connect"; this will link you to the my.rakocontols.com page. RK-HUB Manual Version 1.4.6
Page 8
Makesurethat all “Service Status” is green before proceeding with the following steps: - Step 2: Press “Login/Register” if you already have an account at my.rakocontrols.com; use the email and password that are used for this; if not, create an account. - Step 3: Once logged in, the code within the HUB will be automatically verified. Please wait; this process may take a couple of minutes - Step 4: Once it has been linked, the HUB will ask to be given a “Nickname”. This is howit will be referred to in the my.rakocontrols.com interface. It is not the same as the “HUB name” as defined within the HUB setup wizard. Oncecompleted,themy.rakocontrols.com “Devices” page should appear as below: RK-HUB Manual Version 1.4.6
Page 9
5AddingtheHUBasadevicetoRasoftPro OncetheHUBhasbeensuccessfullyconnected, it will need to be added to the software as a device. Please note that this guide assumes that your project file has already been created as described in the relevant Rasoft programming guide. - Step 1: Select “File”- “New Device” to open the new device wizard. Choose “Bridge” as the device to be added. - Step 2: Select “Next” on the “Assign to Room” step. No room or channel needs to beassociated with the HUB. - Step 3: Select the HUB from the list; it will appear if you are successfully connected in the communications window. Click “Refresh” if it does not appear. - Step 4: The HUB should now appear in the device list with green text and a blue icon. The device is now assigned. 6Uploading the project file Oncetheentire system has been completed, the project file should be uploaded to the HUB.TheHUBstorestheRoom,ChannelandSceneinformationforthesystem.This information is required for the App. to operate correctly. The“Smartphone/WebData”tabisusedtouploadtheProjectFiletotheHUB.Once selected, it will open the page as below. Press “Save & Upload Room Data To Bridge” to upload. RK-HUB Manual Version 1.4.6
Page 10
Type - This will change the appearance of the icon used at the top of the room screen on the App. It will also affect the keypad that appears. For example, a room set to “switch” will showtwobuttons: “on” and “off,” whereas a “blind” type room will show three buttons: "open," "stop,” and "close.” Mode-Themodeoftheroomisonlysetwhen“lighting”isselectedasthetype.Itwill set the variety of “keypad” that will appear in the App. Typically, it is best to make this match the physical keypad in the room. NB 1) If there are a specific number of scenes that are not in the standard 4, 7, or 16 layout, then “namedscenes”shouldbeselected. Give custom names to the scenes in the room editor, andanynumberofscenescanbemadetoappearontheApp. 2) While the order of the rooms can be changed from this screen, the order of the channels is always fixed. To get channels in a specific order, they must be addressed or mapped in the desired order. 7Downloadingtheproject file If information has been uploaded to the HUB, then it is possible to import the Room, Channel and Scene data into a blank project file. Thetabusedfordownloadinginformation from the HUB is called “Room Import,” Select it to open the page below. RK-HUB Manual Version 1.4.6
Page 11
- Step 1: Press “Download Data” at the top of this page. This will open the data for preview on this page. - Step 2: Press “Refresh List” if the rooms do not appear. If no rooms appear or only “default room” or “test bench,” then there is no information to be downloaded from the HUB. - Step 3: Press “Import Data” to write the Room and Channel information into the Project File. - Step 4: Press “Refresh Channel Levels” to write the Scene data into the Project File. Events can be viewed, added, and edited using either Rasoft Pro, the Rako App, or the HUB webpages. It should be noted that calendar event conditions can only be set from the HUB webpageinterface. TheHUBcangenerateautomatedEventsthattrigger commandsatspecific times. For example, it is possible to automatically turn on the Garden lights at Dusk and turn off the Garden lights at Dawn. RK-HUB Manual Version 1.4.6
Page 12
8Events Events can be viewed, added, and edited using either Rasoft Pro, the Rako App, or HUB webpages. It should be noted that calendar event conditions can only be set from the HUB webpageinterface. TheHUBcangenerateautomatedEventsthattrigger commandsatspecific times. For example, it is possible to automatically turn on the Garden lights at Dusk and turn off the Garden lights at Dawn. 8.1 Setting Events using Rasoft Pro HUBEventscanbeviewedandeditedusingRasoftPro.Toopentheeventspageinthe software, select the HUB in the device editor and select the “Events” tab from the top of the window. MappingsList: All Events are listed on the left-hand side of the events tab. Select an event such that it is highlighted to edit the “Event Trigger/Active Days” and “Output Action” sections for this Event. RK-HUB Manual Version 1.4.6
Page 13
Event Trigger/Active Days: "Event Trigger” and “Active Days” are the timing conditions that define when the event will occur. NB Thedawnanddusksettingscanbechangedviathelocationsettings in the webpage interface. An offset from this value can be set from this screen if desired. Output Action TheOutputaction section on the right-hand side of the screen will define the command to besent when both the conditions in “Event Trigger” and “Active Days” are met. NB The“Action” drop-down menu is used to select the command sent when the event is triggered. Typically, these will be scene commands but it is possible to trigger and control Macros, Holiday settings, etc. 8.2 Setting Events using the Rako App. Events can also be created via the Rako App. The method to create events in the App is essentially the same as detailed above. For more information, please refer to the App User Guide. 9Activities 9.1 Setting Events using Activities Events can be set via the “Activities” section of the HUB webpages. Navigate to this by selecting “Activities” from the menu on the left-hand side of the HUB web pages and then selecting “Edit” on “Rasoft Pro Activity.". RK-HUB Manual Version 1.4.6
Page 14
Type: This is the time at which the output of the event will occur. It can be defined via a 24-hour clock or in relation to the year-round tracked dawn/dusk time internal to the HUB. Condition: Acondition requirement can be added to the event that needs to be satisfied for the output of the event to occur. This can be a day of the week or a calendar condition. Output: Thecommandwillbesentwhenthe“Type”and“Condition”arebothmet.Thiswillusually beaScenebutcanalsobealevel,fade,etc. 9.2 Setting Audio Activities ® TheHUBhasbuilt-in templates to integrate with third-party audio players, such as Sonos andBlueSound. - Step 1: Select the “Activities” section on the HUB webpages. - Step 2: Select “Use Template Activity.” RK-HUB Manual Version 1.4.6
Page 15
- Step 3: Choose the template that represents the keypad layout required and select ‘Create Activity’ - Step 4: Select ‘Get Players'; this will scan the local wired network for audio devices, andchoosefromtheselection. RK-HUB Manual Version 1.4.6
Page 16
- Step 5: Select the Virtual Room to which the audio device will be mapped - Step 6: Select ‘Create Activity’ OncetheActivity has been created, the Rako Room selected in the Activity will have the commandsprocessedbytheHUB,whichwillcommunicatewiththeaudiodeviceoverIP. 10Mappings WhenMappingsareused,theHUBcan“listen”toaRakocommand(Source)andperforma certain action (Output Action) every time it is "heard.” RK-HUB Manual Version 1.4.6
Page 17
NB It is usually preferable to use a programmable keypad rather than HUB Mapping when possible. WhereWCMsandRNCsareusedinthesystem,useKeypadMappingratherthanHUBMapping. 10.1 Mapping wireless commands to give multi-room functionality Wireless commands can be mapped to additional wireless commands to make multiple roomsturn on at once. In the example below, “Hall Scene 1” is mapped to also trigger “Kitchen Scene 1.” NB It is also possible to “Enable” and “Disable” maps from other commands via the “Mapping Control” Action. RK-HUB Manual Version 1.4.6
Page 18
10.2 Triggering Macros from Maps WhenaMacroisused,itmustbetriggeredfromamap(thiscouldalsobefromaWCM map,WAVFRmap,etc.).BelowMapping2isanexampleofamapbeingusedtotriggera macro: in this case, “Start Macro 2.” 11Macros Macros allow a sequence of actions to take place when triggered by an Event or Map. The HUBcanstoreupto60Macros,eachofwhichcanhaveamaximumof32steps. TheHUBMacroscreenislocatedonthetabintheHUBdeviceeditor. There are 3 steps in this example Macro: - Room9,AllChannels, Scene 2 - Room17,AllChannels, Scene 1 - Room49,AllChannels, Scene 2 With this simple Macro the HUB will just run through the three commands listed. More complex functionality can be achieved by using the commands in the tables outlined below. 11.1 Writing Macros Macrosteps can be one of four types: Action Pause Delay Goto RK-HUB Manual Version 1.4.6
Page 19
Canbeasimple Arunning Macro will TheMacrocanwaitat TheMacrocanbe command,including stop at a Pause and this step for a defined sent to a defined step Scenes, Fades etc. remain there until it period of time. Useful in this or another Canalso include hears a Continue. whenprogramming Macro. “Macro Control" and PIR timeouts, etc. “MappingControl” for more complex programming. 11.2 Triggering Macros Macros can be triggered in several ways. Most commonly: - Wired device direct Map (WCM, WAVFR, etc.) - HUBMapping - HUBEvent Onceamacrotriggeris sent, it will perform one of four different functions for a Macro: Start Stop Pause Continue This will cause the This will cause a This will cause a This will cause the Macrotostart from Macrothat is already MacrotoPauseat Macrotocontinue the beginning (Step running to Stop whatever step it is from a Paused state, 1), regardless of its running and return to currently running. performing the step current position in the Step 1. immediately after this Macro. andproceeding. NB It is also possible to “Enable” and “Disable” Macros (or parts of Macros) via the “Macro Control” Action. 12Holiday Mode Holiday mode allows the HUB to record normal lighting activity in the system over a period of time. This can then be replayed while the property is empty in order to give a realistic impression that it is occupied. Holiday mode has three states: - Record: Used to create a log of the system. - Playback: Used when the house is unoccupied to replay the information gathered in "Record.” - Idle: Used when the system is in normal occupied operation and no recording is being made. Holiday mode is most easily controlled from the App. However, it is also possible to change the holiday mode state from a keypad map, HUB map, or by selecting commands on the HUBwebpages. NB: For how to control Holiday mode via the App. see “App User Guide.” RK-HUB Manual Version 1.4.6
Page 20
13CustomStrings TheHUBcanbeconfiguredforCustomStringswhicharetriggeredbyRakocommands. Thestrings are defined as ASCII commands sent over various protocols including TCP, UDP, andHTTPtofacilitate communication with external systems or devices. Below is an explanation of each type of string type and its functionality. 13.1 ASCII Custom Strings AnASCIICustomStringis a sequence of standard text characters that the HUB can send to another device when triggered. 13.2 Port Number Each custom string is associated with a specific port number. Different systems or devices listen on predefined port numbers, and it is essential to set this correctly to ensure the commandreachesits target. For example, port 502 might be used to communicate with a device using Modbus TCP, whereas port 80 could be used for HTTP commands. 13.3 TCP TCPstrings are transmitted using the Transmission Control Protocol (TCP), ensuring reliable, ordered delivery of data between the HUB and the target device. A target IP address must bedefinedwhenconfiguringaTCPstringtoidentifythedestination. The string will be sent to this IP address over the specified port. 13.4 UDP UDPsendspacketswithout guaranteeing delivery, making it faster but less reliable. UDP is often used for commands that do not require acknowledgement or for systems where speed is critical. Similar to TCP, a target IP address and port number are required for configuring UDP strings. 13.5 HTTP HTTPstrings are used to communicate with web services or devices that support HTTP. The HUBsupportsvarious HTTP methods such as POST and GET, allowing it to interact with RESTful APIs or other web-based interfaces. Other HTTP methods, such as PUT or DELETE, can also be used depending on the capabilities of the receiving system. These methods allow for a wide range of interactions with cloud-based services, home automation systems, or other IP-enabled devices. RK-HUB Manual Version 1.4.6
Page 21
14UpgradingtheHUB DonotupdatetheHUBthroughRASOFTPro;alwaysdosothroughtheHUBwebpage. - Step 1: Access the HUB webpages as shown in section 3.3 of this manual - Step 2: Using the HUB web pages, select the “Help” section so that you have the pageshownbelow. - Step 3: Click on the updates panel. - Step 4: This will show the current firmware of the HUB as well as the latest version available. RK-HUB Manual Version 1.4.6
Page 22
NB As the HUB is a new product, it will require updates to have all the features available. Complete the following steps to make sure the HUB is updated to the latest firmware and all features are available. 15UDPFeedback It is possible to monitor commands received and transmitted by the HUB. This can be done using the UDP Feedback feature. 15.1 Live feedback In the very bottom right of the software (below the communications window) is the Live Feedback section. Each command received or transmitted by the HUB will appear here, and it is useful for checking commands that have been programmed as desired. NB ABridgeorHUBwillhavetobeconnectedinordertoseethisfeedback. 15.2 UDP feedback log Whenmoredetailedorlong-termfeedback is required, a log of commands received or transmitted by the HUB can be opened. In the toolbar, select “Window” - ”Output” - ”Output” to view the page as below: RK-HUB Manual Version 1.4.6
Page 23
15.3 HUB webpage logs Atimestampedlogofsystemactivity can be found within the HUB webpages. These can be accessed by selecting the “Logs” section of the HUB webpages. Aswell as a description of the address (Room and Channel) and command, the source of the commandcanalsobeviewed. 16Activity States The“Activity States” page in the system settings of the HUB webpages is used to trigger Events, Mappings, and Macros. This can be useful for testing purposes, for example, testing DawnandDuskEventsorMacros. RK-HUB Manual Version 1.4.6
Page 24
Each green number is an active Mapping, Event, or Macro, and by clicking on the box, it will be enabled. This can be verified by selecting the HUB logs where the command should bevisible. RK-HUB Manual Version 1.4.6
Need assistance or looking to source this item?