0 QEES MyKey Online Manual
1 Introduction 2 Product Feature List...2 Battery Specification 2 Temperature Limits 2 Charging.2 Understanding the Menu....3 How to make a selection.....3 Menu selection point...3 Action selection point.3 LED Color Guide....4 Blue Menu..4 Green Menu...4 Purple Menu..5 Configuration 5 Inclusion of MyKey to existing Z-Wave networks..5 Exclusion of MyKey from a Z-Wave network 6 Inclusion in Z-Wave network 6 Association of new products to controller groups.6 Associating existing products to your MyKey..6 Exclusion of a device from network..7 Creating one way link between products..7 Deleting a link between MyKey and a device...7 Controlling devices 8 Activating Scenes...8 Controller Shift/Replication...8 Resetting MyKey... 9 Bridge Mode..9 Software Update 9 Interoperability and Certification.10 Supported Z-Wave Command Classes 10 Controlled Z-Wave Command Classes 10 Basic Command Class Implementation...10 Controller Replication Command Class Implementation 10 Scene Command Classes Implementation... 10 Troubleshooting...11 Specifications...12 Technical Assistance 12 Limited Warranty.12 Equivalence with Z-Wave Terms....12
2 Introduction Congratulations on your new QEES RETO MyKey. With this small compact remote in your hand, you can manage all QEES products and other Z-Wave devices. All QEES products are certified according to the Z-Wave standard. This ensures wireless interoperability with other Z-Wave certified products from other manufactures. QEES MyKey provides an elegant, efficient and energy-saving way of controlling your existing lighting or utility items. QEES MyKey can control all electrical products connected to a QEES Switch or Dimmer and thus help you increase the focus on your power consumption in the desired places in the house. Product Feature List Highly aesthetic elegant design Easy to use Multi-Color LED Upgradeable Software via USB Rechargeable battery (included) with standard USB Charger (not included) Strap/Key ring feature 4 different Association Groups - each mapped on a button (eg. button 1 group 1, button 2- group 2, etc) and each supporting up to 148 associations Battery Specification Li-ion Battery, 3.7V, 160 ma (up to 1 month for normal use), rechargeable Temperature Limits Operating Temperature: -20 Celsius to +50 Celsius Charging QEES MyKey is rechargeable and must be recharged at least 3 hours before use. The battery can be charged by connecting the device to a PC or a USB charger (not included). The device will light orange when charging and solid green once the battery is fully charged. When the internal battery is running low on power, QEES MyKey will flash yellow 3 times every time you operate the device. That is when you will know that now is time to recharge your MyKey. Understanding the Menu System QEES devices use a menu system to make operating their functions easy and intuitive. Color-coded menus provide a clear indication of the functions they make available,
3 allowing you to operate your device with simplicity, instead of forcing you to memorize convoluted combinations of button-press patterns. There are four main points you need to focus on: 1. How to make the selection; 2. The Menu Selection Point; 3. The Action Selection Point; 4. LED Color Guide. 1. How to make a selection Menu Selection once you have decided on a menu click on MyKey button 2 and hold the button in order to select it. While you keep the button pressed the LED will switch off and will flash the menu color and show the first action color (usually cyan). Action Selection - you need to press and hold MyKey button 2 once you reached the option you decided upon (remember you need to be inside a menu for this to happen). As you hold the button pressed the LED will turn off and the device will start performing the selected action, along with the relevant feedback for it. 2. Menu Selection Point To get to the menu selection point you need to hold pressed any two buttons on your QEES MyKey. You know that you have reached the menu selection point if you see white LED feedback. Here you can cycle through all the menu options by clicking on button 3 for cycle up and button 4 for cycle down (note: each click will show a different color representing a different menu): 1. Purple Scene Management; 2. Green Controller Options; 3. Blue Network Options; 4. Red Menu Exit this option takes you out of the menu selection point. 3. Action Selection Point You have decided on a certain menu and selected it as described above. Once you have selected the menu you enter the Action Selection Point. You can now zap through different actions by clicking MyKeys buttons 3 or 4 (cycle up or down between actions). To select a certain action press and hold MyKey button 2 until the LED turns of then release. Each action option has a specific LED feedback as described below: Example: Blue Menu 1. Get controller type blue flash followed by cyan color 2. Start Z-Wave learn mode blue flash followed by yellow color 3. Restore default settings blue flash followed by purple color
4 4. Controller shift blue flash followed by green color 5. Menu Exit blue flash and red color 4. LED Color Guide The menu system we use for MyKey involves LED color action response. In order to make it easy here is a correlation between the action and the LED color displayed: Green represents success (displayed after an action has ended with the proper result) Red represents error (displayed after an action has ended without the proper result) Purple represents sending data (displayed while the device is sending data to another device in the Z-Wave network) Cyan represents receiving data (displayed when the device receives data) Blue represents waiting process (displayed when the device is waiting for data) Orange represent timeout (displayed when the device doesn t get the input in a certain amount of time for an action) Blue Menu (Network Options) In this menu you can perform actions related to the network state of the MyKey. When you want to include/exclude the MyKey to/from your network you go to this menu and select the action that you need. To activate the Blue Menu go to Menu Selection Point and click your way to the blue option. Once you have reached the blue option press button 2 to access the Blue Menu. At this point you have reached the Action Selection Point and the LED feedback you get is blue along with another color (the action color usually cyan for the first action from a specific menu). The actions (that you can cycle through by using buttons 3 and 4 for up and down) and LED feedback associations in the Blue Menu are: 1. Cyan Get controller type; 2. Yellow Start Z-Wave learn mode; 3. Purple Restore default settings; 4. Green Controller shift; 5. Red go back to Menu Selection Point. Green Menu (Controller Options) In this menu you can build a network around your QEES MyKey by adding/removing products to/from its network. To reach the Green Menu you have to reach the Menu Selection Point and click your way to the orange option. Once you reach this option you access it by pressing MyKey button 2. The actions (that you can cycle through by using buttons 3 and 4 for up and down) and LED feedback associations in the Orange Menu are: 1. Cyan Include node to network; 2. Yellow Exclude node from network;
5 3. Purple Signed association; 4. Green Send Network Information Frame; 5. Red go back to Menu Selection Point. Purple Menu (Scene Management) In this menu you can create scenes on your MyKey. A scene is a group of devices at a certain state associated to the same button from your MyKey. At this point each time you select this scene the devices will turn to the state they were when the scene was stored. In order to reach Purple Menu get to Menu Selection Point and click your way to the purple option. Once you reach this option you access it by pressing MyKey button 2. The actions (that you can cycle through by using buttons 3 and 4 for up and down) and LED feedback associations in the Purple Menu are: 1. Cyan store scene; 2. Red go back to Menu Selection Point. Configuration Once you bought the QEES MyKey you can start building your wireless network around it. Inclusion of MyKey to existing Z-Wave networks If you just bought MyKey, but you already have a Z-Wave wireless network built around another controller, then you will want to include the device to the existing network. The steps that must be followed in order to do this are: 1. Go to the Menu Selection Point; 2. Select the Blue Menu and choose the yellow option in order to put your MyKey in Z-Wave learn mode; 3. Then switch your primary controller to inclusion mode to add your new MyKey to the network. Please consult the relevant controller s manual on how to reach inclusion mode ; 4. Your MyKey lights green for 2 seconds and is subsequently added to your existing Z-Wave network. Your MyKey has been added to the network and can now be used to control other devices wirelessly in your Z-Wave network. Exclusion of MyKey from a Z-Wave network At some moment you might want to exclude your MyKey from the network. In order to do this follow the steps: 1. Go to the Menu Selection Point; 2. Select the Blue Menu and choose the yellow option in order to put your MyKey in Z-Wave learn mode;
6 3. Then switch your primary controller to exclusion mode to remove your MyKey from network. Please consult the relevant controller s manual on how to reach exclusion mode ; 4. Your MyKey lights green for 2 seconds and is subsequently removed from your existing Z-Wave network. Inclusion in Z-Wave network & Association of new products to controller groups In order to remotely control any device you need to include it into your wireless Z- Wave network and associate it to one of the MyKey groups. Please take note that each group is mapped to a button (e.g. group 1 is mapped to button 1, group 2 is mapped to button 2, etc.) 1. Press 3 times quickly on the button that you want to use for controlling your device (the LED lights blue) 2. Then press 3 times quickly on the QEES device you want to control QEES device lights purple and it will begin linking. 3. After successful linking between the MyKey and the device, both LEDs will glow green for 2 seconds. 4. To assign more than one device to one button just make sure that you follow the same steps as above. 5. After the linking is finished the device(s) can be controlled wirelessly from your MyKey button. A single press will turn your product on or off. Keep the button pressed down to adjust the light intensity (only for Z-Wave dimmers). 6. By repeating steps 1-3 you can add multiple devices to other buttons on your MyKey. For non-qees devices the MyKey behavior is the same. You need to put your non- QEES device in learn mode and for this please refer to their manual for the procedure Activating Z-Wave Learn Mode. Note: If MyKey is acting as a secondary controller in the Z-Wave network then it can not include other Z-Wave devices. In this case triple pressing one of the buttons will only perform the association process described below. Association of existing products to your MyKey groups Here we have the same 3 steps that we used for association of new devices to group: 1. Press 3 times quickly on the button you want to use to control the device; 2. Then press 3 times quickly on the device which is already added to the network-the device lights purple and it begins linking; 3. After successful linking between MyKey and the device, both LEDs will glow green for 2 seconds; 4. The device can now be controlled wirelessly from your MyKey; 5. For non-qees products please refer to their manual at the section Network Inclusion in order to complete the inclusion process.
7 Another way to associate a device to a group is by using ASSOCIATION_SET command, from the Association Command Class, sent over Z-Wave from another device. Exclusion of a device from the network With the help of QEES MyKey you can also remove a device from your Z-Wave network by following the steps: 1. Go to the MyKey Green Menu and select the yellow action exclude node from network action; 2. Select the yellow action from the Blue Menu on the QEES slave device that you want to remove; 3. The QEES device and MyKey will both glow green for 2 seconds; 4. The device has now been removed from the network and can be added to another Z-Wave network; 5. For non-qees products please refer to their manuals for how to start Z-Wave learn mode. Creating one-way link between products QEES MyKey also provides you with another option to link two different Z-Wave products between them directly. In order to do that you have to follow the next steps: 1. Go to the green menu on your MyKey and select the purple option; 2. Press 3 times quickly on the QEES device to be linked as a slave unit (the MyKey LED lights green) the device will send a Node Information Frame; 3. Then press 3 times quickly on the QEES device to be linked as the controlling device (the MyKey LED flashes green) the device will send a Node Information Frame; 4. Your one-way link has been created. Now press the configured QEES control device and make sure that the other QEES device is turned on; 5. For non-qees products please refer to their manual in order find out how to send a Node Information Frame. Deleting an association between MyKey and a device You can always delete the association between MyKey and the device from a specific group on your MyKey by repeating steps 1 to 3 under Associating existing products to your MyKey. Basically the same steps have to be done in order to delete the association. Controlling Devices After association of a device to a group and implicitly to a button you can start controlling the device with the help of MyKey. The controlling action can be described as follows: - a single click on a button toggles all the devices in the group corresponding to that button by sending a BASIC_SET command ;
8 - holding a button dims up or down all devices in the group that are identified as capable of dimming (supports the Multi Level Switch Command Class) releasing the button stops the dimming process; Note: Even if a device in a group is capable of dimming, holding a button will not dim it up or down if the association to this device was created with the Z-Wave Association Command Class, because this Command Class does not offer information about the type of the associated device; MyKey will be capable of dimming up and down only devices that were associated manually. Activating Scenes MyKey provides to the end user the option to use the scene concept. This means that you can assign to a button a certain state of a group of devices. At this point toggling on the scene will take the devices to that specific state. In order to activate a scene you need to double press any button of MyKey. You can have up to four scenes each of them associated to one of the buttons from the MyKey. Example: if you want to activate the scene stored on button 1 you need to double press it. Controller Shift/Replication If your MyKey is acting as a primary controller inside your Z-Wave network it can transfer its primary role to a secondary controller from the same network. After the transfer takes place MyKey will become a secondary controller and will lose its capability of including other nodes in the network. In order to initiate the controller shift procedure you need to follow the steps below: 1. on the MyKey go to the Blue Menu and select the Green option; 2. on the secondary controller initiate the Z-Wave Learn Mode (refer to the product manual if not a QEES device); 3. MyKey will flash its LED blue during the procedure and green at the end in case of success; 4. During the controller shift procedure MyKey will attempt to replicate its application data (groups) to the other controller using the Controller Replication Command Class. Note: During the controller replication procedure MyKey will try to transfer only its group information, not the scene information. Transferring the scene information will be available in a future software release. If your MyKey is acting as a secondary controller inside your Z-Wave network it can accept the primary controller role from the device currently holding it. In order for this to happen you need to follow the steps below: 1. on the primary controller start the controller shift procedure according to the product s documentation; 2. put your MyKey in Z-Wave Learn Mode by going in the Blue Menu and selecting the Yellow option; 3. MyKey will start to flash blue during the procedure and green at the end in case of success;
9 4. During the controller shift procedure MyKey will attempt to replicate any application data (groups) transferred by the primary controller using the Controller Replication Command Class. Note: During the controller replication procedure MyKey will accept only group information from the primary controller. It will ignore the scene information transferred by the primary controller. Accepting also scene information will be available in a future software release. Resetting MyKey You can reset default settings on your QEES MyKey by going in the Blue Menu and selecting the purple option. This procedure will delete all associations and scenes made on MyKey. Another type of reset is the Hardware Reset and it can be done by keeping pressed down for approximately 40 seconds button 4 of your MyKey. This procedure will reset the device if it behaves erratically or does not respond to actions keeping the associations and scenarios made on MyKey. Bridge Mode When plugged into the USB port MyKey goes into the Bridge Mode State. In this state the device will expose a serial port interface to the PC and can be used with a PC software application called QEES PC Controller. You can exit Bridge Mode and return to Controller Mode by pressing any button. The device will automatically go back to the Bridge Mode after 60 seconds of inactivity. Software Update As all other QEES devices QEES MyKey can be upgraded with new features when a new firmware is released. In order to do this you must follow the next sequence of steps: 1. Connect your MyKey to the computer through a USB port. Depending on the operating system you will either be asked to install a driver for this device automatically or you will need to do it manually; 2. Install QEES PC Controller software freely provided by QEES (you can find the installer and the installation instructions on www.qees.eu); 3. Put your MyKey in USB Update mode by pressing down any two buttons while the device is making one of the charging-related feedbacks (charging or charged). The LED will light solid green once in USB Update mode; 4. Refer to the QEES PC Controller documentation on how to upload the new firmware image on MyKey. Interoperability and Certification All QEES Z-Wave devices are Z-Wave Certified. This guarantees that QEES Z-Wave devices will be interoperable in a network with other third party Z-Wave Certified devices. Every mains powered device can be used as a repeater inside a Z-Wave network. Supported CCs: Basic Command Class
10 Association Command Class Version 2 Version Command Class Controller Replication Command Class Version 1 Wake Up Command Class Version 2 Scene Controller Configuration Command Class Version 1 Controlled CCs: Basic Command Class Multi Level Switch Command Class Version 2 Association Command Class Version 2 Controller Replication Command Class Version 1 Scene Activation Command Class Version 1 Scene Actuator Configuration Command Class Version 1 Basic Command Class Implementation Using the Basic Command Class with MyKey has no effect on the way the device operates. However, after receiving a Basic Set Command, MyKey will store the specified value and will report it back when being queried with the Basic Get Command. Controller Replication Command Class Implementation The controller replication is performed only during the Controller Shift procedure. MyKey will support both transferring its application data to another controller and accepting application data from another controller. Note that in the current software release only group information is replicated. Replication of scene data will be available in a future software release. Scene Command Classes Implementation The controller works with both scenes and groups. QEES Switches and Dimmers can perform various scenarios (scenes) that were configured on them. In Z-Wave terminology, this makes them a type of Scene Actuator, and the scenes are configured using the Scene Actuator Configuration Command Class. The MyKey can send them a command to activate a scene using the Scene Activation Command Class. Some of the parameters (dimming duration and dimming level) that were set on a scene actuator can be overridden by it, and the overriding parameters can be set using the Scene Controller Configuration Command Class. A scene is a group made up by multiple devices, at a certain state, controlled from a single button. A scene is identified by a unique number called Scene ID. When asking the devices in the network to store the current state as a scene, the devices store it with the numeric ID of the button to which they are associated on the MyKey: e.g. if you send a "Store Scene" command to the devices in group 2, they will remember those settings in the scene with a Scene ID equal to 2. This is done with the help of Actuator Configuration Command Class. The scene state is to be set by the user previously by taking all the devices in the group to the final level intended for the scene. This state is stored and the scene can be
11 activated later by using double click on a button. The action will be noticeable only if the scene device state differs from the state the device is currently in. The Scene Controller Configuration Set Commands can be used from the PC controller to configure the dimming duration that will be used by MyKey when sending a Scene Activation Set Command. Note: A slave device can be part of multiple scenes and at different state. It is possible to use the MyKey for activating scenes set up using another controller, by setting the scene ID for a particular group through the Scene Controller Configuration command class. However, note that when sending a store scene command, the ID under which the new scene is stored is again going to be equal to the ID of the group. Troubleshooting Problem Possible Cause Solution MyKey may be out of Try moving closer to a Z- range of the nearest Z- Wave device and enable Wave equipment that can network wide inclusion on act as a repeater the device that you want to MyKey won t add a device, reports an error or timeout MyKey is not responding Devices previously associated provide no feedback when pressing the controlling button The Z-Wave device has to be in inclusion mode in order to be added MyKey may not have inclusion privileges The device you are trying to add is functioning on another frequency The MyKey battery could be empty The MyKey could be glitched Light bulb is burned out Load not properly installed MyKey may be out of range of the nearest Z- Wave equipment that can act as a repeater MyKey could be in bridge mode add in the network Try using the steps you find in the manual at chapter: Adding devices to network. Make sure the device is primary controller (see the manual for steps required). Please make sure that both the MyKey and the device you want to add in a network function on the same frequency (eg. EU 868 MHz, US 908 MHz) Proceed with recharging steps Proceed with hardware reset procedure Try changing the light bulb with a new one. Try checking if the wiring was made according to manual instructions. Try moving closer to a Z- Wave device. Press a button to exit bridge mode and resume
12 Pressing a button on MyKey returns error LED feedback No devices associated to the pressed button MyKey could have been reseted to factory default normal use Try adding a new device using the steps from the manual Try adding a new device using the steps from the manual Specifications Supply voltage: Li-ion battery, 3.7V 160mA Battery power: Up to 1 month for normal use Transmission frequency: EU:868.42 MHz, / US: 908.42 MHz Protection rating: IP 20 Only for indoor use Charging time: Approximately 3 hours Technical Assistance For questions concerning the installation or operation of this product, please call QEES Support Center. EUROPE, USA, CANADA (24hrs/7days) (+45) 81 41 10 10 Limited Warranty QEES products come with one (1) year warranty starting with the date of purchase. During this period the all QEES products are free from manufacturing defects and comply with the specifications in the manual. The devices not complying with the above facts will be repaired, replaced or refunded by QEES only if the products have not been subject to faulty use, improper installation or abuse. Defective products during warranty period have to be shipped along with dated proof of purchase to: QEES A/S Kultorvet 9, kl. 1175 Kobenhavn, Denmark QEES is in no case liable for: (1) the improper, inappropriate or negligent use of the products by the Buyer or any third party; (2) the failure by the Buyer or any third party to comply with QEES instructions (whether oral or in writing) for the storage, location, installation, maintenance, use or operations of the products, or in the absence of instructions, according to the most common practice in the relevant field; (3) the use of products on unsuitable equipment or for a use not expressly authorised by QEES; (4) the failure by the Buyer or any third party to implement QEES recommendations regarding the products; (5) any repair, adjustment, alteration or modification of products by the Buyer or any third party. Equivalence with Z-Wave Terms
13 QEES Terminology Add device to network Remove device from network Controller Shift Z-Wave Terminology Inclusion Process Exclusion Process Controller Change and Controller Replication