plotly interface based on ardunio sample code
Library for plotting a simple x/y scatter chart on the plot.ly website.
See plotly_HelloWorld for sample usage.
Diff: plotly.h
- Revision:
- 8:d4f705ba2ea5
- Parent:
- 7:9409a72ab6c0
--- a/plotly.h Tue Jul 29 13:30:31 2014 +0000 +++ b/plotly.h Tue Jul 29 13:43:31 2014 +0000 @@ -10,16 +10,20 @@ /** Create a plot on plot.ly * -* Based on the Ardunio code supplied by plot.ly +* Creates a streaming X/Y scatter plot with line on the plot.ly site. +* Multiple lines can be drawn however each line currently requires a seperate network socket so you could easily run out of resources if you're not careful. +* I've only tested 1 and 2 line plots. * -* Creates a streaming X/Y scatter plot with line on the plot.ly site. -* Update periods can be between 50ms and 60s due to limitations imposed by plot.ly. +* In theory each line could be plotted by a different mbed but this would require some changes to the way charts are initalised. +* +* Update periods can be between 50ms and 60s. Anything faster will be filtered, anything slower will result in the connection getting closed. * * Requires an mbed with network support. * -* Provided as is, it works for me but your mileage may vary. Sorry, I don't have time to offer much support on this. +* Based on the Ardunio code supplied by plot.ly and provided as is, it works for me but your mileage may vary. +* Sorry, I don't have time to offer much support on this. * -* You will need to create a plot.ly account and then go to https://plot.ly/settings to get your API key and a streaming token. +* You will need to create a plot.ly account and then go to https://plot.ly/settings to get your API key and streaming tokens. * * See Plotly_HelloWorld for a sample implimentation. * @@ -35,7 +39,7 @@ @param filename The name of the file to save the chart as @param nTraces The number of traces (MUST match the size of stream_tokens, can be omitted for a single line) */ - plotly(const char *username, const char *api_key, const char ** stream_tokens, const char *filename, int nTraces = 1); + plotly(const char *username, const char *api_key, const char *stream_tokens[], const char *filename, int nTraces = 1); ~plotly(); @@ -45,7 +49,7 @@ Time taken for this function can vary depending on network delays. - If you wish to change any of the options line max points or world readability then make sure you change them BEFORE calling this function. + If you wish to change any of the options like max points or world readability then make sure you change them BEFORE calling this function. */ bool init(); @@ -85,7 +89,7 @@ */ void openStreams(); - /** close all the streaming connections + /** Close all the streaming connections Call to tidy up and free up system resources once there is no more data to send */