Changes between Version 1 and Version 2 of WikiStart


Ignore:
Timestamp:
2012-06-30 20:26:04 (12 years ago)
Author:
docbliny
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v1 v2  
    1 = Welcome to Trac 0.12.3 = 
     1= Introduction = 
     2[[Image(yamaha_rx_v3800.jpg)]] 
    23 
    3 Trac is a '''minimalistic''' approach to '''web-based''' management of 
    4 '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress. 
     4The Yamaha Receiver Plug-In for Vera allows you to remotely control several receivers models from your Vera dashboard. Your receiver must be connected to your network using an Ethernet-to-serial (RS232) adapter. The plug-in supports around 200 discrete commands and makes various status information items available to Vera (not all commands are exposed in the user interface). 
    55 
    6 All aspects of Trac have been designed with the single goal to  
    7 '''help developers write great software''' while '''staying out of the way''' 
    8 and imposing as little as possible on a team's established process and 
    9 culture. 
     6== Requirements == 
     7* Vera: Vera version 1.0.989 or above (required for `stxetx` protocol). The plug-in has only been tested on Vera UI4. 
    108 
    11 As all Wiki pages, this page is editable, this means that you can 
    12 modify the contents of this page simply by using your 
    13 web-browser. Simply click on the "Edit this page" link at the bottom 
    14 of the page. WikiFormatting will give you a detailed description of 
    15 available Wiki formatting commands. 
     9* Yamaha RX-V3800 
     10* Yamaha RX-V1800 (untested) 
     11* Yamaha HTR-6190 (untested) 
    1612 
    17 "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created 
    18 a new Trac environment, containing a default set of wiki pages and some sample 
    19 data. This newly created environment also contains  
    20 [wiki:TracGuide documentation] to help you get started with your project. 
     13* Ethernet-to-serial adapter, such as the Sena !HelloDevice LS100, configured and connected to the receiver. 
    2114 
    22 You can use [wiki:TracAdmin trac-admin] to configure 
    23 [http://trac.edgewall.org/ Trac] to better fit your project, especially in 
    24 regard to ''components'', ''versions'' and ''milestones''.  
     15== Possible Compatible Devices == 
     16* Other RX-series receivers may also be compatible. 
    2517 
     18= Installation =  
     19== Upload the Required Files == 
     201. Download the latest release, and then unzip the contents to your local machine. 
     211. Open the Vera console, and then click '''MiOS developers'''. 
     221. In the ''MiOS developers'' window, select the '''Luup files''' tab. 
     231. Scroll to the end of the page, click '''Choose File''', and then select a file from the ''Luup'' folder. 
     241. Repeat for every file in the ''Luup'' folder. 
     251. Check '''Restart Luup after upload''', and then click ''GO''. 
     261. Wait for Vera to load the files. 
    2627 
    27 TracGuide is a good place to start. 
     28== Add the Receiver == 
     291. Click the '''Create Device''' tab. 
     301. In the '''!UpnpDevFilename''' field, type `D_YamahaReceiver1.xml`. 
     311. In the '''!UpnpImplFilename''' field, type `I_YamahaReceiver1.xml`. 
     321. Enter the IP address of your Ethernet-to-serial adapter connected to the receiver. 
     331. Choose the room your receiver is in. 
     341. Click ''Create device''. 
    2835 
    29 Enjoy! [[BR]] 
    30 ''The Trac Team'' 
     36= Notes = 
     37* Thanks go to the people who created the Denon, Onkyo, and Panasonic plug-ins. 
    3138 
    32 == Starting Points == 
     39= Releases = 
     40* 06/30/2012: Initial release. 
    3341 
    34  * TracGuide --  Built-in Documentation 
    35  * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project 
    36  * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions 
    37  * TracSupport --  Trac Support 
     42= Discussion = 
    3843 
    39 For a complete list of local wiki pages, see TitleIndex. 
     44= Additional Information = 
     45The project source also includes a handy utility that allows you to develop Vera UI panels using any standard HTML development tools. The utility can be found in the `util` folder, and by executing the `exportControls()` method in your browser's !JavaScript console will output the required JSON object for a Vera UI panel. 
     46 
     47By annotating standard HTML input controls you can add Vera-specific options, such as specifying which controls are displayed on the dashboard, which commands should be sent to Vera, and which variables should be used for display purposes. Using this method you can use an HTML editor for positioning and layout of controls in the Vera panel and use HTML files as the source of truth for the `Control` sections of your static Vera JSON files. The following tables list the supported HTML elements and data attributes. 
     48 
     49== Supported HTML Elements== 
     50||= HTML Element =||= Vera Control =|| 
     51||`input type="button"`||Button|| 
     52||`input type="checkbox"`||Checkbox|| 
     53||`input type="text"`||Either a text input field or a variable depending on whether the `readonly="readonly"` attribute and value is set.|| 
     54||`span`||Label|| 
     55 
     56== Supported HTML Attributes == 
     57||= HTML Attribute =||= Description =|| 
     58||`style`||Converts the `width`, `height`, `left`, and `top` CSS styles as entries for in the `Display` element.|| 
     59||`value`||The text to display when used with `input` elements.|| 
     60||`data-control-group`||Sets the attribute value as the !ControlGroup value.|| 
     61||`data-display-service`||The uPnP service to retrieve a variable from.|| 
     62||`data-display-variable`||The variable to display data from.|| 
     63||`data-display-value`||The initial (variable) value to display.|| 
     64||`data-command-service`||The uPnP service to call.|| 
     65||`data-command-action`||The action to call in the service.|| 
     66 
     67== Examples == 
     68The following shows an HTML snippet that creates a static label, a label that displays text from a variable, and two buttons that turn on a device on and off. 
     69 
     70{{{ 
     71<div id="cpanel_content"> 
     72   <span style="position:absolute;width:150px; height:20px; left: 10px; top: 5px;">Yamaha RX-V3800</span> 
     73   <input data-control-group="1" data-display-service="urn:yamaha-com:serviceId:Receiver1" data-display-variable="Zone1Message" data-display-value=" " type="text" readonly="readonly" style="position:absolute;width:325px; height:20px; left: 10px; top: 25px;"/> 
     74 
     75   <input data-control-group="2" data-command-service="urn:upnp-org:serviceId:SwitchPower1" data-command-action="SetTarget" data-command-parameters='{"Name": "newTargetValue", "Value": "0"}' data-display-service="urn:upnp-org:serviceId:SwitchPower1" type="button" value="All Off" style="position:absolute;width:75px; height:30px; left: 440px; top: 5px;"/> 
     76   <input data-control-group="3" data-command-service="urn:upnp-org:serviceId:SwitchPower1" data-command-action="SetTarget" data-command-parameters='{"Name": "newTargetValue", "Value": "1"}' data-display-service="urn:upnp-org:serviceId:SwitchPower1" type="button" value="All On" style="position:absolute;width:75px; height:30px; left: 535px; top: 5px;"/> 
     77</div> 
     78}}} 
     79 
     80= Author = 
     81Created by Tomi Blinnikka. http://www.bliny.net