Changes between Version 1 and Version 2 of WikiStart

Timestamp:

2014-02-15 03:05:59 (11 years ago)

Author:

anonymous

Comment:

--

WikiStart

@@ -1 @@
-= Welcome to Trac 0.12.3 =
+HarmonyHubControl
+=========
 
-Trac is a '''minimalistic''' approach to '''web-based''' management of
-'''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.
+A Qt-based C++ executable to control the Logitech Harmony Hub/Link 
+without need of the Logitech Harmony App or Remote.
 
-All aspects of Trac have been designed with the single goal to 
-'''help developers write great software''' while '''staying out of the way'''
-and imposing as little as possible on a team's established process and
-culture.
+HarmonyHubControl was developed using the pyharmony library as a guide.  
+It was written in C++ using Qt to allow simpler packaging than pyharmony
+and to reduce the number of dependencies.
 
-As all Wiki pages, this page is editable, this means that you can
-modify the contents of this page simply by using your
-web-browser. Simply click on the "Edit this page" link at the bottom
-of the page. WikiFormatting will give you a detailed description of
-available Wiki formatting commands.
+HarmonyHubControl was developed particularly to ease Harmony Hub/Link 
+integration within home automation systems.
 
-"[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created
-a new Trac environment, containing a default set of wiki pages and some sample
-data. This newly created environment also contains 
-[wiki:TracGuide documentation] to help you get started with your project.
-
-You can use [wiki:TracAdmin trac-admin] to configure
-[http://trac.edgewall.org/ Trac] to better fit your project, especially in
-regard to ''components'', ''versions'' and ''milestones''. 
+Special thanks to jterrace and petele for laying down the groundwork for 
+this work to occur by implementing pyharmony.
 
 
-TracGuide is a good place to start.
 
-Enjoy! [[BR]]
-''The Trac Team''
+Protocol
+--------
 
-== Starting Points ==
+As the harmony protocol is based on xmpp (the Jabber protocol).  
+A thorough description of the exchanges between the executable, Logitech's
+Harmony Web service, and the Harmony Hub can be found in the included 
+PROTOCOL.md file, or in the original pyharmony GitHub repositories at: 
 
- * TracGuide --  Built-in Documentation
- * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
- * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
- * TracSupport --  Trac Support
+https://github.com/jterrace/pyharmony/
+and
+https://github.com/petele/pyharmony/
 
-For a complete list of local wiki pages, see TitleIndex.
+
+
+Functionality
+--------------
+
+HarmonyHubControl provides the ability to perform the following functions
+without requiring the Logitech Harmony App or Remote.
+
+* Authenticate using Logitech's web service
+* Authenticate to the local harmony device.
+* Query for the harmony's entire configuration information.
+* Request a list of activities and devices from the harmony
+* Request the currently selected activity
+* Start an activity by ID
+
+
+
+Requirements
+------------
+
+In order to successfully use the executable, it is expected that the following
+are in place:
+
+A Harmony Hub/Link that is pre-configured and working properly on the local network
+Your Logitech Harmony login email and password.  These are the same ones used in
+the app or online to edit the Harmony's configuration.
+
+The IP address of the Harmony is required.
+
+
+
+Usage
+-----
+
+The command line for HarmonyHubControl is as follows:
+
+    HarmonyHubControl.exe [email] [password] [harmony_ip] [command (optional)]\n");
+    
+where the [email] and [password] parameters are the login credentials used to log 
+into your Logitech Harmony account to update the device configuration.  These are
+also the same credentials used with the Harmony app.
+
+[harmony_ip] is the IP address of the harmony device on your network
+
+
+[command] can be any of the following:
+
+        get_current_activity_id
+        list_devices
+        list_activities
+        start_activity [ID]
+        get_config
+
+
+Typical example usage would be as follows:
+
+1) Query the device for a list of activities:
+
+        HarmonyHubControl.exe your_email@your_email_server.com your_password 192.168.0.XXX list_activities
+
+2) Start an activity based on the activity identifiers listed in step 1:
+
+        HarmonyHubControl.exe your_email@your_email_server.com your_password 192.168.0.XXX start_activity
+
+For full argument information simply run the executablewith no parameters.
+
+
+
+Building from Source
+--------------------
+
+Building the executable from source requires an install of Qt. The only version tested is 5.2.0 on 
+Microsoft Visual Studio 2010 on Windows (x86)
+
+Once Qt is installed, a visual studio project file can be generated using qmake:
+
+        qmake -tp vc HarmonyHubControl.pro
+
+The application has no dependencies beside Qt, therefore Qmake should configure the project file 
+automatically to allow compiling and running the application.  
+
+
+
+To-do
+--------------------
+
+Finish the "issue_command" interface to allow individual commands to be sent to devices.
+Re-organize the code into a library