Skip to content

Commit

Permalink
prep for plugin store
Browse files Browse the repository at this point in the history
  • Loading branch information
kmarkley committed Nov 29, 2017
1 parent 7eef5cc commit 3ffe9e4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 127 deletions.
11 changes: 9 additions & 2 deletions Mac Apps.indigoPlugin/Contents/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<plist version="1.0">
<dict>
<key>PluginVersion</key>
<string>0.0.4</string>
<string>0.0.5</string>
<key>ServerApiVersion</key>
<string>2.0</string>
<key>IwsApiVersion</key>
Expand All @@ -13,13 +13,20 @@
<key>CFBundleIdentifier</key>
<string>com.morris.mac-apps</string>
<key>CFBundleVersion</key>
<string>1.0.0</string>
<string>1.0.1</string>
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLName</key>
<string>https://github.com/kmarkley/Indigo-Mac-Apps</string>
</dict>
</array>
<key>GithubInfo</key>
<dict>
<key>GithubRepo</key>
<string>Indigo-Mac-Apps</string>
<key>GithubUser</key>
<string>kmarkley</string>
</dict>
</dict>
</plist>
126 changes: 1 addition & 125 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,127 +1,3 @@
# Mac Apps
## Mac Apps

This plugin uses shell commands (`ps`) to determine if processes are running on the machine running Indigo Server and obtain some statistics about them. Processes may be launched or quit by turning the associated Indigo device on or off.

## Plugin Configuration

* **Update frequency**
How often to check whether applications are running.

* **Push stats frequency**
How often to updtate the statistics in the device states. Statistics will change every time for running applications, which can mean more communication with Indigo. Reduce this setting if you start seeing "ServerCommunication" errors in the log.

* **Divide %CPU by cores**
By default, Macs report percent cpu of a single core. Check the box to make the plugin report a a true percentage of total capacity.

* **Enable debugging**
If checked, extensive debug information will be written to the log.

## Devices

### Application

This is for standard applications with a **.app** extension (likely hidden) that usually reside in the /Applications folder.

#### Configuration

* **Application name**
The name of the application (exclude the **.app** extension).

* **Use Applications folder**
Check if the application is in the `/Applications` folder.

* **Directory path**
For applications **not** in the `/Applications` folder, specify the full path to the directory containing the application.

* **Open fresh**
Check to launch the application 'fresh', without restoring previous windows and documents.

* **Open in background**
Do not bring application to the front after launching.

* **Use force quit**
Force the application to close even if there are unsaved changes.

* **Use special process name**
Occaisionally applications will have a different name reported by the `ps` command than they have in the Finder. If so, check this box.

* **Process name**
If the applications has a different name in `ps`, list it here.

#### States

* **Process Status**
The current status of the process. Values are 'Idle', 'Running', 'Stopped', 'Waiting', 'Zombie', or 'Off'.

* **Process ID**
The process id.

* **Last Start**
Timestamp of the last time the process was started.

* **Elapsed Seconds**
Elapsed running time as an integer in seconds.

* **Elapsed Time**
Elapsed running time as a string in format DD-HH:SS.

* **Percent CPU**
The percent of CPU capacity the process is using as a float.

* **Percent Memory**
The percent of memory the process is using as a float.

### Helper

This is for helper applications *without* a **.app** extension, *not* in the `/Applications` folder, and probably faceless.

#### Configuration

* **Helper name**
The name of the name (including extension if any) of the helper application.

* **Directory path**
The full path to the directory containing the helper application.


#### States

Same as above.

### Daemon

Uses `launchctl` command to add and remove jobs to `launchd`. If the daemon was launched by another process, quitting may fail.

#### Configuration

* **Daemon process name**
The name of the name (including extension if any) of the daemon.

* **Directory path**
The full path to the directory containing the daemon.

* **Start command arguments**
Optional arguments used when launching daemon.

#### States

Same as above.

### System Load

This device reports the total CPU and Memory utilization of the Indigo Server machine.

#### Configuration

No configuration, but you must 'SAVE' the cofiguration dialog!

#### States

* **Percent CPU**
The percent of CPU capacity as a float.

* **Percent Memory**
The percent of memory as a float.

* **Display State**
String combining percent CPU and percent memory.

0 comments on commit 3ffe9e4

Please sign in to comment.