Plugins development

[Bartek]

Hi, I'm new to HG. I have got an automation system built on CAN BUS with bridge module that gives access to the system via TCP. Now, I found HG and it looks very nice for me, with C# especially.

I want to develope a plugin, that makes easy access to my system, and my question is how to do this? I've read this forum and docs, but I feel a bit confused. Is there any good tutorial or hello world plugin, that can be installed via HG manager? I see there's x10 plugin on github, but its code spread over few other projects.

I know I can use TCP helper, but I want put ugly translating CAN code to plugin and then access its commands from HG scripts.

[dani]

You can look at the code of Philips Hue Bridge In HG Programs - Devices and things

[Bartek]

But this is just a program script. I want make much more complicated plugin (interface), with use of external assemblies. Is it possible to write such code without compiling whole HG or MIG, just to make a plugin and install it by System > Install Addons button?

I also have some other plugins idea, which requires some external assemblies and the program scripts aren't a good enough for that. So my goal is to write external dll and plug it into the HG, then use it in programs. Am I think correctly?

[dani]

In that case, you can refer to the src code of ZWaveLib.dotnet. it is now an external référence for MIG interface

[Gene]

You can develop Add-Ons for HG, here some examples:

https://github.com/genielabs/HomeGenie/blob/master/BaseFiles/Common/ADDONS.md

An HG Add-On can then be packaged as a distributable zip file and so imported from the UI from Configure->Settings->Install Add-On option.

[Bartek]

Thanks, I'll check that.

[Gene]

Hi Bartek,

it turns out that there was a bug with the Add-On install functionality, so ensure to be using at least HG v1.1 r498 (currently only available as source code on github) where the bug is fixed.

Cheers,
g.

[Bartek]

Hi again.
I've build r500, made setup file and install new version.

Then I add new project to mig solution with copy of x10 interface plugin, then remove all x10 code, leaving just empty class with MigInterface methods implemented.
Then modify zip files. When I try to install plugin a windows with button proceed is being shown, after that nothing happend.
In logs I've got something like this (some lines are in Polish language)

Code: [Select]

2015-11-10 22:38:45.3586 Info WebServiceGateway 169.254.80.80 HTTP GET 200 /api/HomeAutomation.HomeGenie/Config/Interface.Install [OPEN]
2015-11-10 22:38:45.3586 Debug Interface not found Onixarts.TestOA
2015-11-10 22:38:45.3586 Debug Interface not found Onixarts.TestOA
2015-11-10 22:38:45.3711 Error System.IO.FileNotFoundException: Nie moLLna zaL,adowaÄ? pliku lub zestawu 'file:///C:\Program Files\HomeGenie\Onixarts.MIG.Interfaces.Test' lub jednej z jego zaleLLnoL>ci. Nie moLLna odnaleLsÄ? okreL>lonego pliku.
Nazwa pliku: 'file:///C:\Program Files\HomeGenie\Onixarts.MIG.Interfaces.Test'
   w System.Reflection.RuntimeAssembly._nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, RuntimeAssembly locationHint, StackCrawlMark& stackMark, IntPtr pPrivHostBinder, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks)
   w System.Reflection.RuntimeAssembly.InternalLoadAssemblyName(AssemblyName assemblyRef, Evidence assemblySecurity, RuntimeAssembly reqAssembly, StackCrawlMark& stackMark, IntPtr pPrivHostBinder, Boolean throwOnFileNotFound, Boolean forIntrospection, Boolean suppressSecurityChecks)
   w System.Reflection.RuntimeAssembly.InternalLoadFrom(String assemblyFile, Evidence securityEvidence, Byte[] hashValue, AssemblyHashAlgorithm hashAlgorithm, Boolean forIntrospection, Boolean suppressSecurityChecks, StackCrawlMark& stackMark)
   w System.Reflection.Assembly.LoadFrom(String assemblyFile)
   w MIG.MigService.TypeLookup(String typeName, String assemblyName)
   w MIG.MigService.AddInterface(String domain, String assemblyName)

=== Informacje o stanie sprzed powiÄ.zania ===
DZIENNIK: Where-ref bind. Location = C:\Program Files\HomeGenie\Onixarts.MIG.Interfaces.Test
DZIENNIK: Appbase = file:///C:/Program Files/HomeGenie/
DZIENNIK: Initial PrivatePath = NULL
Zestaw wywoL,ujÄ.cy: (Unknown).
===
DZIENNIK: to powiÄ.zanie zaczyna siÄT w kontekL>cie L,adowania LoadFrom.
OSTRZEL»ENIE: Obraz macierzysty nie bÄTdzie sondowany w kontekL>cie LoadFrom. Obraz macierzysty bÄTdzie sondowany tylko w domyL>lnym kontekL>cie L,adowania, takim jak Assembly.Load().
DZIENNIK: uLLycie pliku konfiguracji aplikacji: C:\Program Files\HomeGenie\HomeGenie.exe.Config
DZIENNIK: uLLycie pliku konfiguracji hosta:
DZIENNIK: uLLycie pliku konfiguracji komputera z C:\Windows\Microsoft.NET\Framework64\v4.0.30319\config\machine.config.
DZIENNIK: to samo powiÄ.zanie byL,o widoczne wczeL>niej i nie powiodL,o siÄT z hr = 0x80070002.

2015-11-10 22:38:45.3711 Info WebServiceGateway 169.254.80.80 HTTP GET 200 /api/HomeAutomation.HomeGenie/Config/Interface.Install [CLOSED AFTER 0,014 seconds]
There info says, that it can't load assembly or its reference. But there is no additiona references in my project.

Have You any suggestions about that?

[Bartek]

After some pdb battle I'm able to debug homegenie and found that:

Code: [Select]

public MigInterface AddInterface(string domain, string assemblyName = "")
        {
            MigInterface migInterface = GetInterface(domain);
            if (migInterface == null)
            {
                try
                {
                    var type = TypeLookup("MIG.Interfaces." + domain, assemblyName);
                     [...]

My plugin has another namespace prefix... You should mention that in documentation

So one problem solved... who's next .

[Gene]

You're right Bartek,

miig plugin documentation is something I hope to do soon, in the meantime feel free to ask for support here in the forum.

Cheers,
g.

[[email protected]]

This has come at just the right time as I am about to start writing a plugin.. Once i can get system.net.http to work in mono.. but first time trying to write any exe to run in mono as well as .net

What are you using as the target framework?

[maxflax]

How do you call your plugin functions from your HG program script Bartek? Also coding on a plugin with functionality not fitted for the HG Script Programs.

[[email protected]]

you can make api calls.. have a look at Zwave - Once you enable the zwave plugin you will then see the scripts that interact..

When looking for the method name it will replace the . with an underscore _

So Get.Value will be get_value (without looking at code)

David

[maxflax]

This actually helped me when I found the z-wave MIG lib and got the pieces of the puzzle to fit.
Thanks David