Home
Content
1. Getting Started
Developing new Controls for your personal needs is really simple and there is no need for special skills. You do not need to be a coding guru or professional software developer to create new Controls.

With each Control you have the option to develop up to 12 new workflows which can be executed via a customized shortcut or the Controls Panel of your Control. The Controls Panel consists of 12 buttons and a display which can be used to display messages of your workflows to give the user feedback or introduction on how to use this workflow.


2. Creating a New Control

Click on the plus button in the bottom left corner to create a new Control. This will bring up a "New Control" Sheet which lets you set Control icon, display icon, Control name, author, developer link, Control description. Once you are done click ok and you will see a new Control with your name and 12 empty workflows. Click on the edit button next to each workflow to get to the workflow editor where you can create your workflow and name the workflow button. Be sure that you test your buttons in the Control Panel, so they are not too long.


3. Icon Guidelines

Controls can have up to 2 different icons.
The main Control icon which is 512 x 512 px and should look like any application icon matching the Mac Aqua style but can be simpler in terms of details.
The display Control icon which is 52 x 52 px and should be monochrome with a light blue color: RGB: 68/184/218. Please see the included Controls for icons and be sure that your icons look similar.


4. The Workflow Editor

The Workflow Editor is separated in three kinds of scripting. You can develop with Automator, Apple Script or Shell Script. You can also enter a name of your button here. Choose the right type for developing your control. You can also convert between those types when possible.


5. Developing with Automator

This type allows you to import an Automator workflow or edit it directly in Automator which gives you access over all the powerful features known in Automator. When done, test run your workflow and click "Done" in the bottom right corner.


6. Developing with Apple Script

This type allows you to script with Apple Script. It has all the powerful options built-in known from Apple Script Editor like syntax highlighting and more. When done, test run your workflow and click "Done" in the bottom right corner.


7. Developing with Shell Script

This type allows you to script using shell commands. Choose the shell script type and start coding, everything is possible. When done, test run your workflow and click "Done" in the bottom right corner.


8. Converting Types

The workflow editor can also convert those three types. In detail converting from Apple Script to shell script, from shell script to Apple Script and from Apple Script and shell script to Automator is possible. For technical reasons converting Automator actions other than Apple Script and shell script is not possible.


9. Adding Feedback Through the Control Panel Display and Overlays

When developing Controls you should also give feedback to the user on what the workflow is doing or guiding the user to the workflow. This is especially important to show the user whether a workflow was successfully executed or not.

When to use display messages: The display should only be used when the information which is shown should be displayed longer then just for a moment. For example: Guiding the user through the workflow, showing the current radio station in a Control for an Internet radio application, and so on.

When to use overlays: overlays should be used for information which should appear for some seconds and afterwards disappear. For example: workflow successfully executed, and so on.

Controls can display messages and feedback or output from scripts and Automator actions from within the "Display Text" action which is accessible from Automator's action library. You can find the action under Library/Text in Automator. In the action you can select whether to display your message in the Control Panel display or as an overlay. When using the Control Panel display be sure to select the right Control where this message should be shown. Overlays can be shown for a special Control or as a global Cockpit overlay. Further more you can choose between displaying an output o a previous script or Automator action or displaying a custom message. Please refer to the Apple Script dictionary (Applescript Editor > File > Open Dictionary) for getting the Apple Script commands for using the "Display Text" options.


10. Testing Your Control

When you have scripted all your workflows please test your Control. Make sure to have the most important workflows on the dark middle buttons in the Control Panel. Also make sure that the workflow names are not too long for the Control Panel buttons. Also check if your icons fit the style and size they should. Please refer to "3. Icon Guidelines" for more information.


11. Submitting Your Control to the Gallery

Once you have developed your own Control you can submit it to the Gallery and share it with Cockpit users around the world. Therefore select your created Control and click on the "Submit to Gallery" button in the top right corner of the right view in the Controls Manager.

Please allow us some time to review your Controls until they will be available in the Controls Gallery!
How to Easily Develop Controls?