NI Home
Cart Cart | Help
Company Events Academic NI Developer Zone Support Solutions Products & Services Contact NI MyNI

8 Replies Last post: Jul 11, 2009 2:26 AM by James Kring  
David Wisti   9 posts since
Oct 29, 2008
Currently Being Moderated

Jul 9, 2009 1:07 PM

My First Right-Click Plugin

Ok so it was way too easy to make a plugin, see attached plugin. My plugin allows you to set the disabled property of controls on the front panel. Someting I do quite often and on multiple controls.  I called it Disabled Property.  To install it, you need to unzip the folder into the <LabVIEW>\resource\JKI\RCF\Plugins\ folder and restart the framework.

 

I do have a few question that could make my plugin better.

 

1) This property can only be accessed on the front panel.  Can I set this property from the block diagram?

 

2) Should I put my VI into a llb like the ones from VIPM?

 

3) How do you get the pretty icon, mine looks like a plug?

RCF icon.png

4) What should I do for the license so everyone can use it?

 

5) Can I make it into a package for VIPM?

Attachments:
PJM_JKI   81 posts since
Mar 2, 2009
Currently Being Moderated
Jul 9, 2009 2:08 PM in response to: David Wisti
Re: My First Right-Click Plugin

David,

 

Congratulations on your first plugin!

 

I am glad that you though the process of writing a plugin was easy. We worked hard to make this process as simple as possible.

 

1) This property can only be accessed on the front panel.  Can I set this property from the block diagram?

Hmm, I am not entirely sure what you mean about this.

 

2) Should I put my VI into a llb like the ones from VIPM?

Yes you can. Ultimately you will want to have your plugin installed in "LabVIEW root\resource\JKI\RCF\Plugins\your Plugin Name". Source plugin (plugin you work on located where the "plugin development source directory" path point to [see here]) are not run as efficiently as installed plugin.

 

3) How do you get the pretty icon, mine looks like a plug?

You have to make sure you set the glyph in you plugin (see image below). If no glyph is detected, the option window display a default "plug" image.

plugin glyph.png

4) What should I do for the license so everyone can use it?

You could use the BSD license (or any other that you feel confortable with).

 

5) Can I make it into a package for VIPM?

Yes you can. As a matter of fact, all the existing plugin are build with VIPM Package Building (VIPB).

 

Below are some screenshots describing the process (using the "Create Enum From String" plugin as an example).

 

First, fill out the field in the Main VIPB window (you can reuse the same glyph for the package icon that you use on the plugin)

 

Plugin building main.png

Once you are done filling out the main area of the VIPB, go to the advanced settings.

 

In the Dependencies area, make sure you depend on the "jki_too_right_click_framework" package (see image below).

 

Plugin building advanced - dependencies -.png

Next go to the installation location and make sure that you use a custom location and that the "Library VIs Installation Folder" is set to "<resource>\JKI\RCF\Plugins\Your Plugin Name"

 

Plugin building advanced - install locations -.png

Thats about it.

 

Close the advance setting and click on the build button VIPB build button.png in VIPB main UI.

 

Good luck.

 

PJM

James Kring   128 posts since
Feb 28, 2008
Currently Being Moderated
Jul 9, 2009 2:20 PM in response to: David Wisti
Re: My First Right-Click Plugin

David,

 

3) How do you get the pretty icon, mine looks like a plug?

 

An easy way to manage your icon is to just use the plugin VI's own icon (by calling the VI.VI Icon.Get as Image Data method), as shown below:

 

Use Plugin VI Icon.png

4) What should I do for the license so everyone can use it?

 

That's a short question with a long answer.  If you want to give people the right to modify, redistribute, and your code in a way that's very flexible for your users, I personally like the BSD open-source license.  However, please consult with your own attorney

James Kring   128 posts since
Feb 28, 2008
Currently Being Moderated
Jul 10, 2009 4:20 PM in response to: David Wisti
Re: My First Right-Click Plugin

I have created a new document called List of Community Plugins for the JKI Right-Click Framework where we can list plugins like your Build Array of References.  I've linked to this discussion thread.  I'm thinking that plugin authors should create a new page for thier plugin where they can post documentation, a download of the latest version, revision history, etc.  This page can also link to a discussion topic (like this one) where the plugin author can support users of thier plugin.

James Kring   128 posts since
Feb 28, 2008
Currently Being Moderated
Jul 11, 2009 2:26 AM in response to: David Wisti
Re: My First Right-Click Plugin

We chose to create the community for the RCF on the NI Communities site, so that we could be along-side the LabVIEW APIs group, where the scripting discussions are happening.  We want to find good synergy between the efforts.

 

Ya, we could probably use the document comments as a support thread.

More Like This

  • Retrieving data ...