Changes between Version 34 and Version 35 of WikiStart


Ignore:
Timestamp:
2010-07-27 00:11:10 (14 years ago)
Author:
woodsby
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v34 v35  
    11= ActiveRFID =  
    22== Description == 
    3 This plugin is intended to provide affordable RFID support to Vera, using ActiveRFID Hardware.  Currently, this plugin has only been tested using multiple transmitters and one USB RSSI receiver plugged directly into Vera. It is fully functional on UI2, and has been verified on UI4 beta.  This has also been tested using multiple receivers connected to vera, locally and over IP using the IPSerial plugin. Check this Description and the Roadmap for current status and upcoming milestones for this project. 
     3This plugin is intended to provide affordable RFID support to Vera, using ActiveRFID Hardware. Currently, this plugin has only been tested using multiple transmitters and one USB RSSI receiver plugged directly into Vera. It is fully functional on UI2, and has been verified on UI4 beta. This has also been tested using multiple receivers connected to vera, locally and over IP using the IPSerial plugin. Check this Description and the Roadmap for current status and upcoming milestones for this project. 
    44 
    55[[Image(ActiveRFID.PNG)]] 
    66 
    77== Where to Buy == 
    8 The ActiveRFID hardware, formerly known as cheaperRFID, can be purchased from [http://cliste.sailwhatcom.com/catalog/1 Cliste Electronics].  I recommend purchasing the USB RSSI receiver, as eventually I intend to provide signal strength based events; and the difference in cost is negligible. I also recommend purchasing transmitters without any sealant, especially if you are purchasing multiple 40m transmitters.  It's much easier to identify each transmitter if you pull all the batteries, and put them back in, one transmitter at a time. It's easy enough to seal them yourself using plastic dip or liquid electrical tape. 
     8The ActiveRFID hardware, formerly known as cheaperRFID, can be purchased from [http://cliste.sailwhatcom.com/catalog/1 Cliste Electronics]. I recommend purchasing the USB RSSI receiver, as eventually I intend to provide signal strength based events; and the difference in cost is negligible. I also recommend purchasing transmitters without any sealant, especially if you are purchasing multiple 40m transmitters.  It's much easier to identify each transmitter if you pull all the batteries, and put them back in, one transmitter at a time. It's easy enough to seal them yourself using plastic dip or liquid electrical tape. 
    99 
    10 Please note that I am not affiliated with Cliste Electronics in any way.  I'm just a customer.  I will say that they are responsive, and they deliver within 5 days in the US. 
     10Please note that I am not affiliated with Cliste Electronics in any way.  I'm just a customer. I will say that they are responsive, and they deliver within 5 days in the US. 
    1111 
    1212== Setup == 
    … …  
    1414Before getting started setting up the plugin, a little effort is required to get the USB Receiver supported by Vera. 
    1515 
    16 1. Plug your RFID receiver into one of Vera's USB ports. 
    17  
    18 2. Log in to your Vera using SSH. If you have never done this, you can refer to the instructions provided in the Luup Somfy Walkthrough [http://wiki.micasaverde.com/index.php/Luup_Somfy_Walkthrough#Step_1:_SSH_into_Vera here]. 
    19  
    20 3. Enter the following at the command prompt: 
    21 {{{ 
    22 echo "vendor:067b product:2303" >> /etc/cmh/serproxy.ports 
    23 }}} 
    24  
    25 4. Now the hardware is set up. Keep your SSH session open. 
    26  
    27 5. Download the latest ActiveRFID plugin from this site.  This should include all of the following files: 
     161. Download the latest ActiveRFID plugin from this site. This should include all of the following files: 
    2817 * D_ActiveRFID.xml 
    2918 * D_RFIDTransmitter.json 
    … …  
    3322 * S_RFIDTransmitter.xml 
    3423 
    35 6. Log into Vera using any web browser.  Navigate to Devices > Luup plugins > Luup files. 
     242. Log into Vera using any web browser. 
    3625 
    37 7. Load all six of the plugin files, check the box labeled "Restart Luup after upload", and click "GO". 
     263. In the Toolbox, click the "MiOS developers" icon. 
    3827 
    39 [[Image(7-Upload.PNG)]] 
     28[[Image(1-Toolbox.PNG)]] 
     29 
     304. A new window will pop up; select the "Luup Files" tab. Scroll to the bottom, and load all six files. Check the box labeled "Restart Luup after upload", and click "GO". Close out of this window by clicking the X in the top right corner. 
     31 
     32[[Image(2-Upload.PNG)]] 
    4033 
    4134=== Receiver Setup === 
     35At this point, please note if you are installing more than one transmitter, setup is much easier if you pull the batteries from all your transmitters, and put them back in, one transmitter at a time. 
    4236 
    43 8. Navigate to Devices > Luup plugins.  Scroll down to "Add device" at the bottom of the page, type "D_ActiveRFID.xml", select the room for your RFID receiver, and click "Add Device". 
     375. Plug your RFID receiver into one of Vera's USB ports, or if none are available, plug in a USB hub and plug the RFID receiver into that. 
    4438 
    45 [[Image(8-AddReceiver.PNG)]] 
     396. Once again, in the Toolbox, click the "MiOS developers" icon, but this time select "Create device".  Under "UpnpDevFilename", type "D.ActiveRFID.xml" (no quotes). Select a room and click "Create device". Then, close this window by clicking the X in the top right corner. 
    4640 
    47 9. Scroll up to your new device, type in a name, confirm the room, and click "Save". 
     41[[Image(3-CreateReceiver.PNG)]] 
    4842 
    49 [[Image(9-NameReceiver.PNG)]] 
     437. Back at the dashboard, scroll down to your new device.  Click the wrench beside your device name, and select the "Advanced" tab.  Name your receiver, then close this window. Scroll up to the top of the dashboard, and click "Save". 
    5044 
    51 10. Navigate to Devices > Luup plugins > Serial Port configuration. Find the new serial device that has been created for your receiver. Under "Used by device", select the device you created in step 8. 
     45[[Image(4-NameReceiver.PNG)]] 
    5246 
    53 [[Image(10-Serial.PNG)]] 
     478. Once again, click the "MiOS developers" icon, but this time select the "Serial Port configuration" tab. Here you should find your new serial device, named "pl2303". Rename this if you'd like. At the "Used by device" field, select the new device you created in steps 6-7. 
    5448 
    55 11. Click Save. 
     49[[Image(5-SerialPortConfig.PNG)]] 
     50 
     519. Once you select the device, you will automatically be redirected to your device config screen. Close out of this by clicking the X in the top right corner. 
     52 
     53[[Image(6-SerialPortAssign.PNG)]] 
     54 
     5510. Click Save. 
    5656 
    5757=== Transmitter Setup === 
    58 If you are installing more than one transmitter, setup is much easier if you pull the batteries from all your transmitters, and put them back in, one transmitter at a time. 
     58As mentioned above, at this point you should only have one transmitter with batteries in it. This makes identifying each transmitter easier. 
    5959 
    60 12. Navigate back to Devices > Luup plugins, and find the device you created.  Expand it by clicking the "+" to the right.  For "Transmitters", enter the number of transmitters you wish to add.  Then, click "Save".  This should create a child device for each transmitter you will add. 
     6011. At this point, just wait. Your transmitter should be identified. You will see the "Server Busy" dialog once for the save process in step 10, and once for each transmitter found. 
    6161 
    62 [[Image(12-NumTransmitters.PNG)]] 
     62[[Image(7-Wait.PNG)]] 
    6363 
    64 13. Back at your SSH session, type the following: 
    65 {{{ 
    66 tail -f /var/log/cmh/LuaUPnP.log | grep RFID 
    67 }}} 
    68 You should see something like this: 
    69 {{{ 
    70 root@HomeControl:~# tail -f /var/log/cmh/LuaUPnP.log | grep RFID 
    71 50      07/01/10 15:04:39.601   luup_log:68: RFID tag 1iW9 found by receiver 68, but not assigned to a device. <0x3c10> 
    72 50      07/01/10 15:04:41.556   luup_log:68: RFID tag 1iW9 found by receiver 68, but not assigned to a device. <0x3c10> 
    73 50      07/01/10 15:04:43.747   luup_log:68: RFID tag 1iW9 found by receiver 68, but not assigned to a device. <0x3c10> 
    74 }}} 
    75 Please note the 4-character tag ID that is returned. 
     6412. Once your transmitter is found, put batteries into each additional transmitter, one at a time, and note which transmitter is associated with each device created. The rule of thumb is to wait approximately 1-2 minutes between adding each transmitter. Once complete, you should see all of your identified transmitters. 
    7665 
    77 14. At your web browser, expand the child device created for your transmitter by clicking the "+" beside it.  For "TagID", enter the 4-character ID found in the previous step.  Click Save. 
     66[[Image(8-TransmittersFound.PNG)]] 
    7867 
    79 [[Image(14-NameTransmitter.PNG)]] 
     6813. Name your transmitters by clicking the wrench beside each one and clicking the "Advanced" tab. 
    8069 
    81 15. Your new child device should now be tripped.  Repeat steps 13-14 for each transmitter. 
     70[[Image(9-NameTransmitter.PNG)]] 
     71 
     7214. Click "Save". 
     73 
     74=== Adjusting === 
     75By default, a signal (transmission) received from a transmitter expires in 15 seconds. What this means is that when the transmitter is out of range, the plugin will "untrip" after 15 seconds. This is adjustable by editing the "Expire Time" variable in the RFID receiver device. 
     76 
     7715. Back at the dashboard, find your RFID receiver device created in step 6-7, and click the wrench beside it. Click the "Advanced" tab.  Scroll down to the "Expire Time" variable, and enter the desired time in seconds. 
     78 
     79[[Image(10-AdjustExpire.PNG)]] 
     80 
     81Please note that the plugin will calculate the number of timers or "buffer" variables based on your Expire Time.  What this means is at the default value of 15 seconds, there are a total of 7 timers created, that will represent the first transmission received, and the next six transmissions that will be received during the following 15 seconds.  When a timer expires, it will start back up with the next transmission that is received.  For this reason, the longer the time, the less likely you will experience false "trips".  I'd recommend setting your Expire Time to no less than 10 seconds, but find the balance of reliability and response that works best for you. 
    8282 
    8383=== Creating Scenes === 
    8484Now that you have your RFID Transmitters working, it's time to add some scenes.  You may want to lock the doors when you leave, open the garage door when you come home, or set the thermostats to Energy Saving Mode only when you're gone. 
    8585 
    86 16. Navigate to Scenes.  Scroll down to the room to which you'd like to add your scene, and click "Add scene". 
     8616. Back at the dashboard, click the "Add Scene" icon at the top left. Name your scene by clicking the bold "New Scene" at the top of this window. 
    8787 
    88 17. Name your scene, and click "Add event". 
     8817. Select the "Events" tab, and click "Add event".  Select one of your transmitters. Choose the type of event, and name it. Select tripped "yes" or "no". 
    8989 
    90 18. For "Device", select a transmitter device. For "Event type", select "Home/Away" or "Armed Home/Away". Name your event and select "Home" or "Away". 
     90[[Image(11-SceneEvents.PNG)]] 
    9191 
    92 19. Expand "Commands" and select the commands you'd like to be associated with the scene. Click "Save". 
     9218. Select the "Commands" tab, then pick a room, and choose the actions you'd like to execute as part of this scene. Close this window by clicking the X at the top right, and click "Save". 
    9393 
    94 [[Image(19-Scene.PNG)]] 
    95  
    96 === Adjusting === 
    97 By default, a signal (transmission) received from a transmitter expires in 15 seconds.  What this means is that when the transmitter is out of range, the plugin will "untrip" after 15 seconds.  This is adjustable by editing the "Expire Time" variable in the RFID receiver device. 
    98  
    99 20. Navigate to Device > Luup plugins, and locate your RFID receiver device.  Expand it, and for the "Expire Time" value, enter the number of seconds in which your transmissions will expire. 
    100  
    101 Please note that the plugin will calculate the number of timers or "buffer" variables based on your Expire Time.  What this means is at the default value of 15 seconds, there are a total of 7 timers created, that will represent the first transmission received, and the next six transmissions that will be received during the following 15 seconds.  When a timer expires, it will start back up with the next transmission that is received.  For this reason, the longer the time, the less likely you will experience false "trips".  I'd recommend setting your Expire Time to no less than 10 seconds, but find the balance of reliability and response that works best for you.  
     94[[Image(12-SceneCommands.PNG)]] 
    10295 
    10396----