Add docs

PinBack23 · Apr 8, 2017 · 260d1b3 · 260d1b3
1 parent f8bcd05
commit 260d1b3
Showing 5 changed files with 88 additions and 0 deletions.
diff --git a/docs/Documentation.md b/docs/Documentation.md
@@ -0,0 +1,43 @@
+# Searching receiver
+To search for a receiver you must know the broadcast port for you device.
+Default Port is **60128**.
+Example:
+{code:c#}
+private static Device SearchDevices()
+{
+    var loDeviceSearch = new DeviceSearch();
+    List<Device> loDeviceList = null;
+    //Try 3 times
+    for (int i = 0; i < 3; i++)
+    {
+        loDeviceList = loDeviceSearch.Discover();
+        //loDeviceList = loDeviceSearch.Discover(60127);
+        if (loDeviceList.Count > 0)
+        {
+            return loDeviceList.First();
+        }
+    }
+    return null;
+}
+{code:c#}
+
+# Sending a command
+If you have found you device you can send a command.
+Example:
+{code:c#}
+using (Connection loConnection = new Connection())
+{
+    if (!loConnection.Connect(loDevice))
+    {
+        Console.WriteLine("Cannot connect to device!");
+        Console.ReadLine();
+        return;
+    }
+    loConnection.MessageReceived += new EventHandler<MessageReceivedEventArgs>((s, e) => Console.WriteLine(e.Message));
+    loConnection.SendCommand(NOnkyo.ISCP.Command.MasterVolume.State);
+    System.Threading.Thread.Sleep(300);
+    loConnection.SendCommand(NOnkyo.ISCP.Command.MasterVolume.UP);
+    System.Threading.Thread.Sleep(300);
+    loConnection.SendCommand(NOnkyo.ISCP.Command.MasterVolume.DOWN);
+}
+{code:c#}
diff --git a/docs/Home.md b/docs/Home.md
@@ -0,0 +1,45 @@
+# NOnkyo
+**Version > 0.13 NET Framework 4.5 needed**
+This is a library and a GUI to communicate with Onkyo AV receivers over the network.
+
+The library uses eISCP (Integra Serial Control Protocol over Ethernet) to control the receivers over an ethernet network connection.
+
+If you would like to make a donation, please click the "Donate" button below.
+![Donate](Home_https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif|https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=EF9R87PWAD6AU)
+## Features
+* Auto Detect receiver
+* Control volume and mute
+* Tuner selection
+* OSD Control
+* Chose input selector and listening mode
+* Net resources
+* Show title, album and artwork
+* Zone support
+* Audiocontrol like bass or treble
+* 3 presets to save and restore audio settings (volume, treble, bass, center lvl and subwoofer lvl)
+* Provide a minimal REST-Api with a web-interface 
+## Not implemented yet
+* Speaker level
+* Commands via RIHD
+* Universal port commands
+* CD / DVD Player commands
+## Detail
+The Application is build with Visual Studio 2012 (VS 2010 Solution) and target .NET Framework 4.5.
+Logging is performed via [NLog](http://nlog.codeplex.com/). By Default there is no logging configuration file defined.
+To enable logging copy a NLog.config file to the Exe Folder.
+I use [LightCore](http://lightcore.ch) as IoC container. There is a command line arguments "FAKE" which init the IoC container with Fake classes.
+The GUI is a WPF-Application (my very first) and is designed with [MahApps.Metro](http://mahapps.com/MahApps.Metro).
+## Remarks
+The project is only tested with **Onkyo TX-NR509** receiver.
+Users have reported that the program also works with following receivers:
+* TX-NR709
+* TX-NR414
+* TX-8050
+* TX-NR818
+* TX-NR515
+* TX-NR525
+* TX-NR929
+## Screenshot
+![](Home_NetRemote.png)
+![](Home_Settings.png)
+![](Home_SelectTracks.png)
diff --git a/docs/Home_NetRemote.png b/docs/Home_NetRemote.png
diff --git a/docs/Home_SelectTracks.png b/docs/Home_SelectTracks.png
diff --git a/docs/Home_Settings.png b/docs/Home_Settings.png