{"_id":"576acf42fb4ccb2b005f25d7","__v":11,"category":{"_id":"5764745b4f867c0e002bc8f1","version":"5764745b4f867c0e002bc8f0","project":"5764745b4f867c0e002bc8ed","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-17T22:06:19.688Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"version":{"_id":"5764745b4f867c0e002bc8f0","project":"5764745b4f867c0e002bc8ed","__v":4,"createdAt":"2016-06-17T22:06:19.667Z","releaseDate":"2016-06-17T22:06:19.667Z","categories":["5764745b4f867c0e002bc8f1","57683255bb15f40e00a288ce","57683306d8067e1900fc823d","57694b8f47693a0e00002b19"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"5764745b4f867c0e002bc8ed","githubsync":"","parentDoc":null,"user":"5564f227f0f70f0d00a9ab20","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-22T17:47:46.834Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/26b2dae-04-octoblu-connectors.png\",\n        \"04-octoblu-connectors.png\",\n        1022,\n        537,\n        \"#252527\"\n      ]\n    }\n  ]\n}\n[/block]\n\nThis tutorial shows you how to create a connector in the Connector Factory and install the connector on your machine.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Navigate to the Connector Factory\"\n}\n[/block]\nGo to [Connector Factory](https://connector-factory.octoblu.com). You will be prompted to link your Octoblu account to the Connector Factory. Once authenticated, you can view the [Dashboard](https://connector-factory.octoblu.com), [My Things](https://connector-factory.octoblu.com/things/my), and [All Things](https://connector-factory.octoblu.com/things/all).\n\n- The [Dashboard](https://connector-factory.octoblu.com) shows your recently installed connectors and the Top Connectors.\n- The [My Things](https://connector-factory.octoblu.com/things/my) shows your installed connectors and things.\n-  The [Available Connectors](https://connector-factory.octoblu.com/connectors/available) shows the available connectors you can install on your machine.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Select a Connector to Create\"\n}\n[/block]\nView the [Available Connectors](https://connector-factory.octoblu.com/connectors/available) and select one from the list.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Select the Connector Version\"\n}\n[/block]\nSelect the version you would like to install, I always recommend using the latest.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Download the Installer\"\n}\n[/block]\nBy now you should be redirected to download the Installer. You are given a few options. Click the button for the OS you are running. Currently we provide the following options:\n\n* **macOS**\n* **Linux x64**\n* **Linux x86**\n* **Windows x64**\n* **Windows x86**\n\nIf you already have downloaded an installer recently, you can copy the OTP (One Time Password) and paste it into the Installer.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"5. Open the Installer\"\n}\n[/block]\n## mac OS:\n\n1. Open the DMG\n2. Open the Installer in mounted image\n\n## Linux:\n\n1. Unzip the Installer whilst maintaining the folder name.\n    - Use the \"Extract Here\" option when right clicking the zip file.\n2. Open the App in the extracted folder\n\n## Windows:\n\n1. Unzip the Installer whilst maintaining the folder name.\n    - Use the \"Extract All\" option when right clicking the zip file.\n2. Open the App in the extracted folder\n    - **IMPORTANT** - make sure to choose option: \"Run as Administrator\" when launching.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"6. Begin the Install\"\n}\n[/block]\n1. Click the \"Begin Install\" button\n2. Wait until the Installer is done. If you run into problems, view the debug information and contact us via the support icon in the \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"7. Configure the Connector\"\n}\n[/block]\nGoing back to the Connector Factory, you can now configure the device. This can either be done by going back to the \"Next Step\" on the download page. Or you can find your connector in the  [My Things](https://connector-factory.octoblu.com/things/my) and click the \"Configure\" action.\n\nWhile on the configure page you should see the following statuses:\n\n1. \"connector is running\" - means your connector is responding to pings and is in a running state\n2. \"connector is responding to pings\" - means your connector is responding to pings but may not be running.\n3. \"thing is online\" - means the connector is connected to meshblu\n4. \"thing is offline\" - means the connector is offline\n5. \"connector error\" - means your connector responded to a ping with an error. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"8. Use it in a Flow\"\n}\n[/block]\nYour installed connector is now available as a Thing in [app.octoblu.com](https://app.octoblu.com/). Add and use the connector in the designer.","excerpt":"","slug":"create-and-install-a-connector","type":"basic","title":"Create and Install a Connector"}

Create and Install a Connector


[block:image] { "images": [ { "image": [ "https://files.readme.io/26b2dae-04-octoblu-connectors.png", "04-octoblu-connectors.png", 1022, 537, "#252527" ] } ] } [/block] This tutorial shows you how to create a connector in the Connector Factory and install the connector on your machine. [block:api-header] { "type": "basic", "title": "1. Navigate to the Connector Factory" } [/block] Go to [Connector Factory](https://connector-factory.octoblu.com). You will be prompted to link your Octoblu account to the Connector Factory. Once authenticated, you can view the [Dashboard](https://connector-factory.octoblu.com), [My Things](https://connector-factory.octoblu.com/things/my), and [All Things](https://connector-factory.octoblu.com/things/all). - The [Dashboard](https://connector-factory.octoblu.com) shows your recently installed connectors and the Top Connectors. - The [My Things](https://connector-factory.octoblu.com/things/my) shows your installed connectors and things. - The [Available Connectors](https://connector-factory.octoblu.com/connectors/available) shows the available connectors you can install on your machine. [block:api-header] { "type": "basic", "title": "2. Select a Connector to Create" } [/block] View the [Available Connectors](https://connector-factory.octoblu.com/connectors/available) and select one from the list. [block:api-header] { "type": "basic", "title": "3. Select the Connector Version" } [/block] Select the version you would like to install, I always recommend using the latest. [block:api-header] { "type": "basic", "title": "4. Download the Installer" } [/block] By now you should be redirected to download the Installer. You are given a few options. Click the button for the OS you are running. Currently we provide the following options: * **macOS** * **Linux x64** * **Linux x86** * **Windows x64** * **Windows x86** If you already have downloaded an installer recently, you can copy the OTP (One Time Password) and paste it into the Installer. [block:api-header] { "type": "basic", "title": "5. Open the Installer" } [/block] ## mac OS: 1. Open the DMG 2. Open the Installer in mounted image ## Linux: 1. Unzip the Installer whilst maintaining the folder name. - Use the "Extract Here" option when right clicking the zip file. 2. Open the App in the extracted folder ## Windows: 1. Unzip the Installer whilst maintaining the folder name. - Use the "Extract All" option when right clicking the zip file. 2. Open the App in the extracted folder - **IMPORTANT** - make sure to choose option: "Run as Administrator" when launching. [block:api-header] { "type": "basic", "title": "6. Begin the Install" } [/block] 1. Click the "Begin Install" button 2. Wait until the Installer is done. If you run into problems, view the debug information and contact us via the support icon in the [block:api-header] { "type": "basic", "title": "7. Configure the Connector" } [/block] Going back to the Connector Factory, you can now configure the device. This can either be done by going back to the "Next Step" on the download page. Or you can find your connector in the [My Things](https://connector-factory.octoblu.com/things/my) and click the "Configure" action. While on the configure page you should see the following statuses: 1. "connector is running" - means your connector is responding to pings and is in a running state 2. "connector is responding to pings" - means your connector is responding to pings but may not be running. 3. "thing is online" - means the connector is connected to meshblu 4. "thing is offline" - means the connector is offline 5. "connector error" - means your connector responded to a ping with an error. [block:api-header] { "type": "basic", "title": "8. Use it in a Flow" } [/block] Your installed connector is now available as a Thing in [app.octoblu.com](https://app.octoblu.com/). Add and use the connector in the designer.