{"_id":"583038c7d8b2150f0091b942","project":"56bc8e679afb8b0d00d62dcf","user":"5703df86a7472a0e00b6de26","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"},"githubsync":"","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"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-19T11:34:31.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"This section contains easy to follow instructions on how to monitor your Buddy data within a realtime freeboard dashboard. \n\nCurrently freeboard can only be used to monitor data sent into metadata APIs. For details about setting metadata within Buddy, see the [metadata documentation](http://docs.buddy.com/docs/set-metadata-value). Telemetry monitoring is coming soon.\n\nThe steps below assumed you have already created a Buddy account and a Buddy project.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Register Device\"\n}\n[/block]\nPerforming a HTTP POST to /devices will return a Buddy token. This token is used to authenticate requests with Buddy. If the received token was \"XYZ\", the following HTTP header would be added to your API calls to Buddy.\n\nAuthorization: Buddy XYZ\n\nSee [http://docs.buddy.com/docs/set-metadata-value](http://docs.buddy.com/docs/set-metadata-value) for full details of setting metadata within Buddy.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Start Sending Metadata\"\n}\n[/block]\nMetadata is a set of key/value pairs.  To update a metadata value, perform a HTTP PUT to https://api.buddyplatform.com/metadata/{project id}/{key}.\n\nThe value could be a simple number or string, or if you want to store multiple values, you could use a JSON structure.\n\nWhen you have started setting metadata within Buddy, you can view the values within the project metadata page in the Buddy portal. The image below provides an example of how 2 different ways of storing metadata values would appear in the Buddy portal.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4ec0d00-Metadata_-_Water_Demo_2_-_Buddy_Portal.png\",\n        \"Metadata_-_Water_Demo_2_-_Buddy_Portal.png\",\n        1970,\n        774,\n        \"#f8e9f1\"\n      ]\n    }\n  ]\n}\n[/block]\nSee [http://docs.buddy.com/docs/register-device](http://docs.buddy.com/docs/register-device) for full details of registering a device with buddy.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Create Freeboard Datasource\"\n}\n[/block]\nTo configure Freeboard,  you will need to either install your own instance of freeboard from ([https://github.com/Freeboard/freeboard](https://github.com/Freeboard/freeboard)), or create an account at [https://freeboard.io/](https://freeboard.io/).\n\nYou must configure all your data sources to point to the different metadata keys you are setting data against.\n\nCreate a data source and set the type to JSON, then use the URL that gets the metadata value you are interested in. The HTTP method should be GET, with the URL ending with the metadata key.  The Authorization key received in step 1 should be set as a HTTP Header. The following image is an example of how a datasource should be configured.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/e7daaa2-freeboard.png\",\n        \"freeboard.png\",\n        1820,\n        1264,\n        \"#292a2a\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Add Freeboard Widget\"\n}\n[/block]\nAdd a pane to your freeboard. Then within the pane click the plus sign to add a widget. You can choose the type of widget you wish to display.  The value in each widget is the the path to the data within the datasource.\n\nThe below image is an example of configuring a text widget to display the current humidity.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cf8d048-frreboard_text_widget.png\",\n        \"frreboard text widget.png\",\n        1792,\n        846,\n        \"#292929\"\n      ]\n    }\n  ]\n}\n[/block]\nThe below image is an example of configuring a sparkline widget to display 3 different values over time.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a5d34e9-freeboard_sparkline.png\",\n        \"freeboard sparkline.png\",\n        1802,\n        814,\n        \"#292929\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. View Freeboard\"\n}\n[/block]\nWhen you are done, you can share a public URL of your dashboard. This can either be displayed on computer screens or put up in front of the office on a large display.\n\nBelow is an example of a freeboard we recently created for the Connected Adelaide Model in the [Adelaide Smart City Studio](http://adelaidesmartcitystudio.com/).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cc47cea-free_cam.png\",\n        \"free cam.png\",\n        1276,\n        836,\n        \"#dcded4\"\n      ]\n    }\n  ]\n}\n[/block]\n\n\nIf you need further clarification or help in setting up Freeboard and Buddy integration, please contact us at [info:::at:::buddy.com]([email protected]).","excerpt":"","slug":"integrating-with-freeboard","type":"basic","title":"Integrating with Freeboard"}

Integrating with Freeboard


This section contains easy to follow instructions on how to monitor your Buddy data within a realtime freeboard dashboard. Currently freeboard can only be used to monitor data sent into metadata APIs. For details about setting metadata within Buddy, see the [metadata documentation](http://docs.buddy.com/docs/set-metadata-value). Telemetry monitoring is coming soon. The steps below assumed you have already created a Buddy account and a Buddy project. [block:api-header] { "type": "basic", "title": "1. Register Device" } [/block] Performing a HTTP POST to /devices will return a Buddy token. This token is used to authenticate requests with Buddy. If the received token was "XYZ", the following HTTP header would be added to your API calls to Buddy. Authorization: Buddy XYZ See [http://docs.buddy.com/docs/set-metadata-value](http://docs.buddy.com/docs/set-metadata-value) for full details of setting metadata within Buddy. [block:api-header] { "type": "basic", "title": "2. Start Sending Metadata" } [/block] Metadata is a set of key/value pairs. To update a metadata value, perform a HTTP PUT to https://api.buddyplatform.com/metadata/{project id}/{key}. The value could be a simple number or string, or if you want to store multiple values, you could use a JSON structure. When you have started setting metadata within Buddy, you can view the values within the project metadata page in the Buddy portal. The image below provides an example of how 2 different ways of storing metadata values would appear in the Buddy portal. [block:image] { "images": [ { "image": [ "https://files.readme.io/4ec0d00-Metadata_-_Water_Demo_2_-_Buddy_Portal.png", "Metadata_-_Water_Demo_2_-_Buddy_Portal.png", 1970, 774, "#f8e9f1" ] } ] } [/block] See [http://docs.buddy.com/docs/register-device](http://docs.buddy.com/docs/register-device) for full details of registering a device with buddy. [block:api-header] { "type": "basic", "title": "3. Create Freeboard Datasource" } [/block] To configure Freeboard, you will need to either install your own instance of freeboard from ([https://github.com/Freeboard/freeboard](https://github.com/Freeboard/freeboard)), or create an account at [https://freeboard.io/](https://freeboard.io/). You must configure all your data sources to point to the different metadata keys you are setting data against. Create a data source and set the type to JSON, then use the URL that gets the metadata value you are interested in. The HTTP method should be GET, with the URL ending with the metadata key. The Authorization key received in step 1 should be set as a HTTP Header. The following image is an example of how a datasource should be configured. [block:image] { "images": [ { "image": [ "https://files.readme.io/e7daaa2-freeboard.png", "freeboard.png", 1820, 1264, "#292a2a" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "4. Add Freeboard Widget" } [/block] Add a pane to your freeboard. Then within the pane click the plus sign to add a widget. You can choose the type of widget you wish to display. The value in each widget is the the path to the data within the datasource. The below image is an example of configuring a text widget to display the current humidity. [block:image] { "images": [ { "image": [ "https://files.readme.io/cf8d048-frreboard_text_widget.png", "frreboard text widget.png", 1792, 846, "#292929" ] } ] } [/block] The below image is an example of configuring a sparkline widget to display 3 different values over time. [block:image] { "images": [ { "image": [ "https://files.readme.io/a5d34e9-freeboard_sparkline.png", "freeboard sparkline.png", 1802, 814, "#292929" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "4. View Freeboard" } [/block] When you are done, you can share a public URL of your dashboard. This can either be displayed on computer screens or put up in front of the office on a large display. Below is an example of a freeboard we recently created for the Connected Adelaide Model in the [Adelaide Smart City Studio](http://adelaidesmartcitystudio.com/). [block:image] { "images": [ { "image": [ "https://files.readme.io/cc47cea-free_cam.png", "free cam.png", 1276, 836, "#dcded4" ] } ] } [/block] If you need further clarification or help in setting up Freeboard and Buddy integration, please contact us at [[email protected]]([email protected]).