{"_id":"582a99414c28ec2700ae85ba","project":"56bc8e679afb8b0d00d62dcf","user":"5703df86a7472a0e00b6de26","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"582a98b6f8c0a0190053d7a5","version":"56bc8e689afb8b0d00d62dd2","__v":0,"project":"56bc8e679afb8b0d00d62dcf","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-11-15T05:10:14.069Z","from_sync":false,"order":2,"slug":"integrations","title":"Integrations"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-15T05:12:33.293Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"This section contains easy to follow instructions on how to integrate SIGFOX Cloud and Buddy Platform. Once configured, SIGFOX device data will be uploaded to Buddy Platform and can be accessed through the Buddy Portal. \n\nThe steps below assumed you have already created a Buddy account and a Buddy project, and a Sigfox account.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Request a Buddy Token\"\n}\n[/block]\nTo push data into Buddy, an Authentication Access Token is required. To request a token please email info:::at:::buddy.com.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Create Buddy Telemetry Container\"\n}\n[/block]\nTelemetry data pushed to Buddy can be grouped by containers. A container keeps related data together so that common actions such as export can be defined per Container. \n\nBefore telemetry data can be sent to Buddy, a telemetry container must be created for the data. The guidelines for specifying the container can be found here: [https://docs.buddy.com/docs/configure-telemetry](https://docs.buddy.com/docs/configure-telemetry).\n\nTo create the container, navigate to “IoT Telemetry” within your project.  Then click on the action ellipses within the “Data containers” section, and select “Add new container”.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0b63f16-create_container.png\",\n        \"create container.png\",\n        1015,\n        604,\n        \"#eb9ac8\"\n      ]\n    }\n  ]\n}\n[/block]\nNext you can enter a name and click the “Create Container” button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/6f317f5-create_container_2.png\",\n        \"create container 2.png\",\n        1015,\n        658,\n        \"#e7e7e7\"\n      ]\n    }\n  ]\n}\n[/block]\nNow your container should appear in the Containers drop down list.\n[block:api-header]\n{\n  \"title\": \"3. Create Telemetry Configuration\"\n}\n[/block]\nTelemetry configuration specifies the structure of the telemetry data to be sent to Buddy. More details are [here](https://docs.buddy.com/docs/configure-telemetry). To get started we can use a blank configuration.\n\nTo create the Configuration, please use CURL as follows: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api-eu.buddyplatform.com/telemetry/Sigfox2 -X PUT -H 'Authorization: Buddy eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOiIyMDE3LTA0LTEyVDIyOjUzOjMxLjU2ODAxMjdaIiwibCI6ImJiYmJ2LkdGZnprRmpNUEdQd2MiLCJhIjoiYmJiYmJjLk5HcE5CeEtLcHBxeGMiLCJ1IjpudWxsLCJkIjoiYmxqLkhOcE5nenZOdGdEeGMifQ.7PVQs9W3-bpfl6j4vC47cZNWvnU4ISVkDIdMIhujGP0' -d '{}'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nIn the above, please note the following:\n\n1. Sigfox2 is the name of the Container. Replace this with your Container name.\n2. If your project was created in a non US region, you need to adjust the api endpoint to include the region:\n\nEU region: https://api-eu.buddyplatform.com/telemetry/Sigfox2\nAU region: https://api-au.buddyplatform.com/telemetry/Sigfox2\nUS region: https://api.buddyplatform.com/telemetry/Sigfox2\n\n3. Auth header has the token that was generated in Step 2.\n4. Last argument -d '{}' specifies the empty configuration. Once you know the structure of your data, you can update the configuration.\n[block:api-header]\n{\n  \"title\": \"4. Manual Data Push to Buddy (for Testing)\"\n}\n[/block]\nWe can now push some data to Buddy using CURL as follows:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl https://api-eu.buddyplatform.com/telemetry/Sigfox2 -X POST -H 'Authorization: Buddy eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOiIyMDE3LTA0LTEyVDIyOjUzOjMxLjU2ODAxMjdaIiwibCI6ImJiYmJ2LkdGZnprRmpNUEdQd2MiLCJhIjoiYmJiYmJjLk5HcE5CeEtLcHBxeGMiLCJ1IjpudWxsLCJkIjoiYmxqLkhOcE5nenZOdGdEeGMifQ.7PVQs9W3-bpfl6j4vC47cZNWvnU4ISVkDIdMIhujGP0' -d '{\\\"data\\\":{\\\"device\\\": \\\"device-001\\\",\\\"data\\\":200} }' -H 'Content-Type:application/json' -H 'Accept: application/json'\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nNow you should see some data in your Telemetry Container.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"5. Configure Sigfox\"\n}\n[/block]\nTo configure Sigfox,  you will need a Sigfox account.\n\nLogin to SIGFOX Cloud at https://backend.sigfox.com and select the Device Type. From the left navigation, select Callbacks. A sample callbacks page is shown below:\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7a07569-sigfox_1.png\",\n        \"sigfox 1.png\",\n        973,\n        697,\n        \"#2e857e\"\n      ]\n    }\n  ]\n}\n[/block]\nTo add a new callback, click the New button at the top right and select Custom Callback. Then fill-in the information as shown below.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0b20137-sigfox_2.png\",\n        \"sigfox 2.png\",\n        973,\n        706,\n        \"#e5e5e5\"\n      ]\n    }\n  ]\n}\n[/block]\nIn this page note the following:\n1.\tURL pattern is in the https://api.buddyplatform.com/telemetry/{{container}} format, where {{container}} is the container name created above (i.e. sigfox); please note that if the project is in a non US region, the endpoint must be changed appropriately (i.e. EU: api-eu, AU: api-au etc);\n2.\tHTTP Method must be POST;\n3.\tAuthorization header key must have the “Buddy “ prefix (with a space after Buddy) followed by the device token obtained from Buddy;\n4.\tContent type must be application/json;\n5.\tCallback body must be wrapped up in a data element. i.e. {“data”: {sigfox data variables}};\n6.\tThe device data should be decoded using the Sigfox custom parameter config. Click the Help icon and follow the guidelines for this.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"6. View Sigfox data in Buddy\"\n}\n[/block]\nTo view data received from SIGFOX, login to Buddy Portal at https://portal.buddy.com/ and select the project.\n\nThe Overview charts show the current activity:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3656026-buddy1.png\",\n        \"buddy1.png\",\n        974,\n        853,\n        \"#1ca7d9\"\n      ]\n    }\n  ]\n}\n[/block]\nTo view more details about Telemetry data, click the IOT Telemetry link on the left navigation panel. On this page, select the Container (i.e. sigfox) to view received data:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9b4d202-buddy2.png\",\n        \"buddy2.png\",\n        974,\n        1017,\n        \"#1aa6d9\"\n      ]\n    }\n  ]\n}\n[/block]\nThis page also gives the opportunity to view detail of the data packet received and export data in a number of formats, including JSON and CSV:\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5ae2359-buddy3.png\",\n        \"buddy3.png\",\n        974,\n        1023,\n        \"#1aa6d9\"\n      ]\n    }\n  ]\n}\n[/block]\nIf you need further clarification or help in setting up SIGFOX and Buddy integration, please contact us at [[email protected]]([email protected]).","excerpt":"","slug":"sigfox","type":"basic","title":"Integrating with Sigfox"}

Integrating with Sigfox


This section contains easy to follow instructions on how to integrate SIGFOX Cloud and Buddy Platform. Once configured, SIGFOX device data will be uploaded to Buddy Platform and can be accessed through the Buddy Portal. The steps below assumed you have already created a Buddy account and a Buddy project, and a Sigfox account. [block:api-header] { "type": "basic", "title": "1. Request a Buddy Token" } [/block] To push data into Buddy, an Authentication Access Token is required. To request a token please email [email protected] [block:api-header] { "type": "basic", "title": "2. Create Buddy Telemetry Container" } [/block] Telemetry data pushed to Buddy can be grouped by containers. A container keeps related data together so that common actions such as export can be defined per Container. Before telemetry data can be sent to Buddy, a telemetry container must be created for the data. The guidelines for specifying the container can be found here: [https://docs.buddy.com/docs/configure-telemetry](https://docs.buddy.com/docs/configure-telemetry). To create the container, navigate to “IoT Telemetry” within your project. Then click on the action ellipses within the “Data containers” section, and select “Add new container”. [block:image] { "images": [ { "image": [ "https://files.readme.io/0b63f16-create_container.png", "create container.png", 1015, 604, "#eb9ac8" ] } ] } [/block] Next you can enter a name and click the “Create Container” button. [block:image] { "images": [ { "image": [ "https://files.readme.io/6f317f5-create_container_2.png", "create container 2.png", 1015, 658, "#e7e7e7" ] } ] } [/block] Now your container should appear in the Containers drop down list. [block:api-header] { "title": "3. Create Telemetry Configuration" } [/block] Telemetry configuration specifies the structure of the telemetry data to be sent to Buddy. More details are [here](https://docs.buddy.com/docs/configure-telemetry). To get started we can use a blank configuration. To create the Configuration, please use CURL as follows: [block:code] { "codes": [ { "code": "curl https://api-eu.buddyplatform.com/telemetry/Sigfox2 -X PUT -H 'Authorization: Buddy eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOiIyMDE3LTA0LTEyVDIyOjUzOjMxLjU2ODAxMjdaIiwibCI6ImJiYmJ2LkdGZnprRmpNUEdQd2MiLCJhIjoiYmJiYmJjLk5HcE5CeEtLcHBxeGMiLCJ1IjpudWxsLCJkIjoiYmxqLkhOcE5nenZOdGdEeGMifQ.7PVQs9W3-bpfl6j4vC47cZNWvnU4ISVkDIdMIhujGP0' -d '{}'", "language": "curl" } ] } [/block] In the above, please note the following: 1. Sigfox2 is the name of the Container. Replace this with your Container name. 2. If your project was created in a non US region, you need to adjust the api endpoint to include the region: EU region: https://api-eu.buddyplatform.com/telemetry/Sigfox2 AU region: https://api-au.buddyplatform.com/telemetry/Sigfox2 US region: https://api.buddyplatform.com/telemetry/Sigfox2 3. Auth header has the token that was generated in Step 2. 4. Last argument -d '{}' specifies the empty configuration. Once you know the structure of your data, you can update the configuration. [block:api-header] { "title": "4. Manual Data Push to Buddy (for Testing)" } [/block] We can now push some data to Buddy using CURL as follows: [block:code] { "codes": [ { "code": "curl https://api-eu.buddyplatform.com/telemetry/Sigfox2 -X POST -H 'Authorization: Buddy eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOiIyMDE3LTA0LTEyVDIyOjUzOjMxLjU2ODAxMjdaIiwibCI6ImJiYmJ2LkdGZnprRmpNUEdQd2MiLCJhIjoiYmJiYmJjLk5HcE5CeEtLcHBxeGMiLCJ1IjpudWxsLCJkIjoiYmxqLkhOcE5nenZOdGdEeGMifQ.7PVQs9W3-bpfl6j4vC47cZNWvnU4ISVkDIdMIhujGP0' -d '{\"data\":{\"device\": \"device-001\",\"data\":200} }' -H 'Content-Type:application/json' -H 'Accept: application/json'", "language": "text" } ] } [/block] Now you should see some data in your Telemetry Container. [block:api-header] { "type": "basic", "title": "5. Configure Sigfox" } [/block] To configure Sigfox, you will need a Sigfox account. Login to SIGFOX Cloud at https://backend.sigfox.com and select the Device Type. From the left navigation, select Callbacks. A sample callbacks page is shown below: [block:image] { "images": [ { "image": [ "https://files.readme.io/7a07569-sigfox_1.png", "sigfox 1.png", 973, 697, "#2e857e" ] } ] } [/block] To add a new callback, click the New button at the top right and select Custom Callback. Then fill-in the information as shown below. [block:image] { "images": [ { "image": [ "https://files.readme.io/0b20137-sigfox_2.png", "sigfox 2.png", 973, 706, "#e5e5e5" ] } ] } [/block] In this page note the following: 1. URL pattern is in the https://api.buddyplatform.com/telemetry/{{container}} format, where {{container}} is the container name created above (i.e. sigfox); please note that if the project is in a non US region, the endpoint must be changed appropriately (i.e. EU: api-eu, AU: api-au etc); 2. HTTP Method must be POST; 3. Authorization header key must have the “Buddy “ prefix (with a space after Buddy) followed by the device token obtained from Buddy; 4. Content type must be application/json; 5. Callback body must be wrapped up in a data element. i.e. {“data”: {sigfox data variables}}; 6. The device data should be decoded using the Sigfox custom parameter config. Click the Help icon and follow the guidelines for this. [block:api-header] { "type": "basic", "title": "6. View Sigfox data in Buddy" } [/block] To view data received from SIGFOX, login to Buddy Portal at https://portal.buddy.com/ and select the project. The Overview charts show the current activity: [block:image] { "images": [ { "image": [ "https://files.readme.io/3656026-buddy1.png", "buddy1.png", 974, 853, "#1ca7d9" ] } ] } [/block] To view more details about Telemetry data, click the IOT Telemetry link on the left navigation panel. On this page, select the Container (i.e. sigfox) to view received data: [block:image] { "images": [ { "image": [ "https://files.readme.io/9b4d202-buddy2.png", "buddy2.png", 974, 1017, "#1aa6d9" ] } ] } [/block] This page also gives the opportunity to view detail of the data packet received and export data in a number of formats, including JSON and CSV: [block:image] { "images": [ { "image": [ "https://files.readme.io/5ae2359-buddy3.png", "buddy3.png", 974, 1023, "#1aa6d9" ] } ] } [/block] If you need further clarification or help in setting up SIGFOX and Buddy integration, please contact us at [[email protected]]([email protected]).