This project is an unofficial community provided client software development kit for IHC (Intelligent House Concept) with clients running Microsoft .NET 7.0 on Windows, Mac and Linux variants (incl. raspberry pi).
This project is released as open source. Please supply pull requests with tested changes. New contributors are welcome!
NOTE: Before running any tests, tools or examples in this repo, please create and configure a private ihcsettings.json file with information on your IHC installation. Refer to the ihcsettings_template.json for details on what is needed. While the file is needed for tests/tools/examples located here, the file is NOT needed in your own projects if you simply consume this SDK. Finally, you also need to enable network access and thirdparty access in the IHC administrator interface app from LK.
- Please notice that this project is not in any way affiliated with- or supported by LK / Schneider Electric. It exist only because Schneider Electric has not yet released a public SDK themselves.
- The project is unofficial, unfinished and may contain serious bugs. Use at your own risk!
- The project is only partially supported. You are welcome to report bugs and feature requests but don't expect quick solutions unless you supply tested pull-requests as well (or offer to pay the author(s) for support).
- The project is intended for experienced .NET developers using C# and/or F#.
- The IHC has only been tested against a single v3.0 controller using both Mac and Windows. More testing from users are needed. Feedback is welcome.
The project is an early preview/beta. It has only been tested against a single v3.0 IHC controller. I don't know if it works with ealier controllers.
Update: Apparently the SDK does not work (yet) with earlier IHC versions due to incompatible changes in webservice contracts between IHC firmware versions. Happily, it is possible to fix this transparently with some help from pre v3.0 contributors. See this Issue to discuss this subject and to keep track of future support.
Definitely missing is an easy to consume nuget package for the client. I expect to publish a package if there is interest. For now you will have to build the client yourself.
See here ihcclient for more details on IHC API implementation status.
This project is hosted in a mono-repo containing the following sub-projects:
- ihcclient contains the code for the IHC client API. This is the project you will need to reference in your own solutions.
- ihcclient_example1 contains code for simple command line client console program in c#. Use this for inspiration on how to get started.
- ihcclient_example2 contains code for simple command line client console program in c#. Use this for inspiration on how to get started.
- ihcclient_tests contains system and unit tests written in c#.
- ihcproject_io_extractor contains an optional command line utility that can generate constant definitions of IO addresses in a concrete IHC installation. Use this approach in your projects if you don't want to lookup and hardcode IO addresses yourself.
Q: Do I need to configure my IHC before running the examples or using the API from my own code?
A: Open the standard IHC administrator app from LK, login, click access control and enable localnet or internet access + "Open for thirdparty products". Only enable internet access if you have a firewall and know how to use it securely.
Q: Why does I get a error message like "Could not copy the file "..\ihcsettings.json" because it was not found." when building/running the projects
A: You must create a "ihcsettings.json" file. Use the template file or example file and fill out your information.
Q: Is there a NuGet package available ?
A: Not yet but planned when the project goes out of beta.
Q: Can I contribute to this project? A: Yes please. See https://docs.github.com/en/get-started/quickstart/contributing-to-projects and https://github.com/mmc41/IHCClientSDK
Q: How do I get support?
A: There is no official support for this SDK but you can post issues on the github site. https://github.com/mmc41/IHCClientSDK.