Monogram API
Search…
⌃K

Initial Config

Create a directory with your app name somewhere on your computer. This directory is the Config Bundle that you will later pass to Monogram.
The Config Bundle tells Monogram how to communicate with your app and what inputs are available for your app.
In this example, we made a directory named myphotoeditor.monogram. Now, add a file named config.json.
path/to/myphotoeditor.monogram
└── config.json
Open config.json and add the following:
{
"name": "MyPhotoEditor",
"id": "com.example.myphotoeditor",
"connection": [
{
"name": "MyPhotoEditorConnection",
"type": "websocket"
}
]
}
id is a globally unique string that allows Monogram Service to identify your application. It is written in Reverse domain name notation. For example, com.example.myphotoeditor for an application named "myphotoeditor" created by a programmer at example.com.
name is a user-friendly string that is shown to the end user.
Substitute the name and id properties with your own information. For details, see ConfigType.
The connection property is an array, as an application may have multiple connections. For details, see ConnectionConfigType. (Errata: Multiple websocket connections are not currently supported)
In this example, the connection's name is the identifier that Monogram uses to maintain the connection with the photo editor.
The websocket connection type is used in this example. Monogram's WebSocket server is located at ws://localhost:59177. Monogram sends commands to your app over this connection when modules (e.g. Dials) are actuated.