Echelon LNS Plug-in - Manual (Page 3)

Table of Contents
Preface .................................................................................................... vi
Purpose ..........................................................................................................vii
Audience.........................................................................................................vii
Software Requirements ..................................................................................vii
Content ...........................................................................................................vii
Related Manuals.............................................................................................vii
Other Related Material ..................................................................................viii
For More Information and Technical Support................................................viii
1 Introduction ....................................................................................... 1
Introduction ...................................................................................................... 2
Overview of Plug-ins ................................................................................. 2
Types of Plug-ins................................................................................ 2
LNS Plug-in Commands ..................................................................... 3
LNS Plug-in Properties ....................................................................... 3
Overview of the LNS Plug-in Framework Developer’s Kit ........................ 3
2 Creating and Redistributing LNS Device Plug-ins ......................... 5
Creating and Redistributing Plug-ins Overview............................................... 6
Installing the Developer’s Kit ........................................................................... 6
Creating the Plug-in Project ...................................................................... 8
Creating the Plug-in Source Files.................................................................. 11
Implementing the Plug-in Server Class................................................... 12
Implementing the Plug-in Object Class................................................... 12
Implementing the Plug-in Form Class..................................................... 17
Registering DeviceTemplate and LonMarkObject Scoped Plug-in
Commands .................................................................................................... 19
Debugging Plug-ins ....................................................................................... 19
Redistributing your Plug-in ............................................................................ 20
3 How Plug-ins Work with Directors................................................. 21
How Plug-ins are Represented In the LNS Object Server ............................ 22
How Plug-ins are Installed and Made Visible to LNS .................................... 22
How Plug-ins Implement the Registration Command ................................... 23
How Plug-ins Respond to Commands from a Director Other than
Registration.................................................................................................... 25
How Directors Launch and Manipulate Plug-ins ........................................... 25
How Directors Support Prelaunch........................................................... 27
How Directors Support MultiObject and SingleInstance ......................... 27
How Directors Pass Object Names......................................................... 29
How Plug-ins Let Directors Know About Errors ...................................... 29
How Plug-ins Know When To Exit .......................................................... 29
What Plug-ins Do When They Run in Standalone Mode .............................. 30
Responding to Property Reads and Writes ................................................... 30
Uninstallation Issues...................................................................................... 31
Appendix A Standard Plug-in Commands ......................................... 33
Appendix B Standard Plug-in Properties........................................... 35
Appendix C Standard Plug-in Object Classes................................... 41
Appendix D Standard Plug-in Exceptions ......................................... 45
Appendix E Glossary ........................................................................... 47