Merge branch 'docs' of https://github.com/akmadian/NZXTSharp into docs

akmadian · Feb 27, 2019 · d682cd0 · d682cd0
2 parents 72e44d3 + 08feb4c
commit d682cd0
Show file tree

Hide file tree

Showing 4 changed files with 150 additions and 32 deletions.
diff --git a/NZXTSharp.sln b/NZXTSharp.sln
diff --git a/NuGet-README.md b/NuGet-README.md
@@ -0,0 +1,36 @@
+# NZXTSharp
+
+[![Documentation Status](https://readthedocs.org/projects/nzxtsharp/badge/?version=latest)](https://nzxtsharp.readthedocs.io/en/latest/?badge=latest) 
+[![Discord](https://img.shields.io/badge/%20-Discord%20Server-blue.svg)](https://discord.gg/yK8m2CU)
+
+NZXTSharp is the one-stop C# SDK for NZXT hardware.
+
+**I am looking for people to help NZXTSharp grow by integrating NZXTSharp with [ProjectAurora][5] and/ or [RGB.NET][6]. If you are
+interested, please contact me on [Discord][7], or by email.**
+
+## Documentation
+Documentation can be found at [NZXTSharp's readthedocs.io page][3]. Docs are built from [the docs branch][4].
+There are also XML docs in the source.
+
+## Disclaimer
+NZXTSharp is provided under the GNU GPLv3 license, but I want to re-iterate these stipulations:
+ - This software is provided as is.
+ - This software is provided with no warranty.
+ - Neither I, nor any of NZXTSharp's collaborators hold any liability for any broken or non-functional hardware resulting from use of this package. Please use your best judgement.
+
+Please keep in mind that NZXTSharp is in development, and will have breaking changes in the future.
+
+For a full changelog, see [the NZXTSharp changelog](https://github.com/akmadian/NZXTSharp/blob/docs-develop/changelog.txt).
+
+A big thank you to [Pet0203][2] for his help in reverse engineering the protocols and building NZXTSharp.
+
+###### </> With ♥ by Ari Madian
+
+[0]: https://www.nuget.org/packages/NZXTSharp
+[1]: https://github.com/akmadian/NZXTSharp/issues/new
+[2]: https://github.com/Pet0203
+[3]: https://nzxtsharp.readthedocs.io/en/latest/
+[4]: https://github.com/akmadian/NZXTSharp/tree/docs-develop
+[5]: https://github.com/antonpup/Aurora
+[6]: https://github.com/DarthAffe/RGB.NET
+[7]: https://discord.gg/yK8m2CU
diff --git a/changelog.txt b/changelog.txt
@@ -0,0 +1,54 @@
+(2.0.0-preview2)
+DeviceLoader; The DeviceLoader provides a convenient interface for interacting with multiple NZXT devices at once.
+
+The DeviceLoader can:
+ - Apply RGB Effects
+ - Set Pump/ Fan Speeds
+to multiple NZXT devices with one line.
+
+More XML docs have been added, the RTD page will be updated with the release of v2.0.0
+
+(2.0.0-preview1)
+Partial Kraken Support
+ - Get Pump, Fan Speeds, Liquid Temp, Firmware Version
+ - Set Pump, Fan Speeds
+ - Some effects working, some partially working, some not implemented/ not working.
+
+Major breaking changes because of a total refactor, docs will be updated with the release of v2.0.0
+
+(1.2) 
+Added ability to create Fixed effect with custom RGB values for all LEDs. 
+This feature offers great versatility for allowing users to create their own effects.
+
+No breaking changes, docs will be updated soon.
+
+(1.1)
+All systems are working! This release is actually v1.0, but because of the way NuGet handles versions, it is 1.1.
+
+This update includes full support for the Hue+ controller.
+
+There are no breaking changes in this update.
+New Things!
+- Bug fixes 
+- Input validation on more constructors
+- The addition of XML docs to all methods, properties, constructors, and classes
+- Little things here and there; cleanup, bits of refactoring, some performance improvements
+
+(1.0.3-beta)
+All effects are now working! Subdevices should also be working. 
+
+- Breaking Changes - N/A
+
+(1.0.2-beta)
+- Breaking Changes
+    - Renamed HexColor.cs to Color.cs
+
+- New Features
+    - Subdevices: Individually control fans, strips, and their individual leds! Documentation and getting started examples        
+      coming soon.
+
+- Behind the Scenes
+    - Addition of COM system, will make it easier to add support for more devices.
+    - Refactoring, moved some files around, cleanup.
+
+Most effects still not working.
diff --git a/docs/Supported.rst b/docs/Supported.rst
@@ -4,7 +4,7 @@ Supported Devices and Features
 
 This list is the most current resource for checking which devices and features are and are not supported. If a device is not listed, it is not supported.
 
-The Hue+ is supported, KrakenX products are next, most likely followed by Hue 2. If you would like to request a specific device or feature, please submit an issue at NZXTSharp's GitHub repo, and tag it with :code:`device-request` or :code:`feature-request`.
+The Hue+ is supported, KrakenX products are partially supported, the Hue 2 is most likely next. If you would like to request a specific device or feature, please submit an issue at NZXTSharp's GitHub repo, and tag it with :code:`device-request` or :code:`feature-request`.
 
 The supported features tables use the following schema for column values:
     - NI - Not Implemented.
@@ -66,3 +66,62 @@ Effects
 +--------------------+----+-----+-----+-----+-----+
 | Wings              |    |     |     |     | X   |
 +--------------------+----+-----+-----+-----+-----+
+
+
+*******
+KrakenX
+*******
+
+Device Features
+=======
++----------------------+----+-----+-----+-----+-----+
+| Feature              | NI | WIP | ITT | TNW | TFW |
++----------------------+----+-----+-----+-----+-----+
+| Get Pump Speed       |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Set Pump Speed       |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Channel On           |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Channel Off          |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Get Fan Speed        |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Set Fan Speed        |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Get Liquid Temp      |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+| Get Firmware Version |    |     |     |     | X   |
++----------------------+----+-----+-----+-----+-----+
+
+
+Effects
+=======
++--------------------+----+-----+-----+-----+-----+
+| Feature            | NI | WIP | ITT | TNW | TFW |
++--------------------+----+-----+-----+-----+-----+
+| Fixed              |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| Fading             |    |  X  |     |     |     |
++--------------------+----+-----+-----+-----+-----+
+| Spectrum Wave      |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| Marquee            |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| Covering Marquee   |    |  X  |     |     |     |
++--------------------+----+-----+-----+-----+-----+
+| Alternating        |    |  X  |     |     |     |
++--------------------+----+-----+-----+-----+-----+
+| Pulse              |    |  X  |     |     |     |
++--------------------+----+-----+-----+-----+-----+
+| Breathing          |    |  X  |     |     |     |
++--------------------+----+-----+-----+-----+-----+
+| TaiChi             |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| Wings              |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| WaterCooler        |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+| Loading            |    |     |     |     | X   |
++--------------------+----+-----+-----+-----+-----+
+