Utveckling av plugin

Switchking / Utveckling av plugin

Utveckling av plugin

[:sv]Switch King erbjuder en plugin-struktur som medger ger möjlighet till viss anpassning av hur Switch King fungerar och bland annat behandlar insamlade värden från datakällor och mottagna signaler från TellStick Duo.

Plugin utvecklas i C# och bygger på interface. Ett plugin som skapats läggs i katalogen ”Plugins” direkt under Switch Kings installationskatalog. När Switch King startas upp läses ditt plugin in i servern och anropas från Switch Kings serverdelar.

Här ges en enkel guide för hur du själv bygger eller modifierar ett plugin i Switch King. För att kunna utveckla plugin krävs erfarenhet i Visual Studio och C#.

 

Börja med att starta Visual Studio 2010. Skapa ett nytt projekt.

 

Välj ”Class Library” och observera att du bör välja .NET Framework 3.5. Ange ett namn för ditt plugin – exempelvis ”MyPlugin”.

 

Switch King erbjuder ett plugin-bibliotek i form av interface. För att få tillgång till de plugin-interface som Switch King kan använda måste du lägga till en referens till Switch Kings plugin-DLL.
Det gör du genom att högerklicka på ”Add Reference…”.

 

Bläddra dig fram till den katalog där Switch King Server är installerad. Välj filen ”SwitchKing.Server.Plugins.dll”.
Klicka ”OK”.

 

Författa din klasstruktur. Klasstrukturen måste ges attributet [ServerPlugin(”Beskrivning på din plugin”)]. Om du inte gör detta kommer Switch King inte att kunna använda ditt plugin.
Importera namespace ”SwitchKing.Server.Plugins” och ge din klass ett attribut. När det är klart, välj det interface som du ska implementera.
Vilket interface som är intressant beror på vad du vill uppnå. Switch Kings webbplats innehåller färdiga plugins med källkod.
Ta gärna en titt på dessa för att kunna avgöra vilket interface du vill använda.

Vid frågor – posta gärna i forumet.

 

När interfacet är valt, högerklicka på interfacenamnet – i det här fallet ”ITelldusEventListener” – och välj ”Implement Interface.”
Visual Studio kommer nu att fylla på med skal för de metoder som krävs för att interfacet ska vara fullt implementerat.

 

Lägg till kod för varje metod som ingår i interfacet. Ta bort alla ”throw new NotImplementedException()” som genereras och ersätt med egen kod.

 

Bygg pluginet och lägg (i det här fallet) ”MyPlugin.dll” i katalogen ”Plugins” direkt under Switch King Servers installationskatalog.
Starta Switch Kings tjänster och låt ditt plugin leva.
Om du har byggt ditt plugin i felsökningsläge/debug så kan du ansluta till ditt plugin när Switch King körs och se exakt vilken information som kommer in till pluginet.

[:en]

Switch King erbjuder en plugin-struktur som medger ger möjlighet till viss anpassning av hur Switch King fungerar och bland annat behandlar insamlade värden från datakällor och mottagna signaler från TellStick Duo.

Plugin utvecklas i C# och bygger på interface. Ett plugin som skapats läggs i katalogen ”Plugins” direkt under Switch Kings installationskatalog. När Switch King startas upp läses ditt plugin in i servern och anropas från Switch Kings serverdelar.

Här ges en enkel guide för hur du själv bygger eller modifierar ett plugin i Switch King. För att kunna utveckla plugin krävs erfarenhet i Visual Studio och C#.

 

Börja med att starta Visual Studio 2010. Skapa ett nytt projekt.

 

Välj ”Class Library” och observera att du bör välja .NET Framework 3.5. Ange ett namn för ditt plugin – exempelvis ”MyPlugin”.

 

Switch King erbjuder ett plugin-bibliotek i form av interface. För att få tillgång till de plugin-interface som Switch King kan använda måste du lägga till en referens till Switch Kings plugin-DLL.
Det gör du genom att högerklicka på ”Add Reference…”.

 

Bläddra dig fram till den katalog där Switch King Server är installerad. Välj filen ”SwitchKing.Server.Plugins.dll”.
Klicka ”OK”.

 

Författa din klasstruktur. Klasstrukturen måste ges attributet [ServerPlugin(”Beskrivning på din plugin”)]. Om du inte gör detta kommer Switch King inte att kunna använda ditt plugin.
Importera namespace ”SwitchKing.Server.Plugins” och ge din klass ett attribut. När det är klart, välj det interface som du ska implementera.
Vilket interface som är intressant beror på vad du vill uppnå. Switch Kings webbplats innehåller färdiga plugins med källkod.
Ta gärna en titt på dessa för att kunna avgöra vilket interface du vill använda.

Vid frågor – posta gärna i forumet.

 

När interfacet är valt, högerklicka på interfacenamnet – i det här fallet ”ITelldusEventListener” – och välj ”Implement Interface.”
Visual Studio kommer nu att fylla på med skal för de metoder som krävs för att interfacet ska vara fullt implementerat.

 

Lägg till kod för varje metod som ingår i interfacet. Ta bort alla ”throw new NotImplementedException()” som genereras och ersätt med egen kod.

 

Bygg pluginet och lägg (i det här fallet) ”MyPlugin.dll” i katalogen ”Plugins” direkt under Switch King Servers installationskatalog.
Starta Switch Kings tjänster och låt ditt plugin leva.
Om du har byggt ditt plugin i felsökningsläge/debug så kan du ansluta till ditt plugin när Switch King körs och se exakt vilken information som kommer in till pluginet.

[:]