HelmSmart-Freeboard Cloud-base Vessel Monitoring using Freeboard.io dashboards

RESTful API for accessing sensor data provided by SeaSmart and netGauges gateways

Sensor data is posted by gateways to the HelmSmart temporal database where it is parsed and stored. The HelmSmart-Freeboard API allows retreival of sensor data by using a set of HTTP GET URLs with specified device API keys and parameters. The selected sensor data is returned in JSON format where it can used by any requestor including the Freeboard.io dashboard.

To use the API with the Freeboard.io dashboards simply enter the URL with parameters as described below in the JSON Datasource. Be sure to enter a update interval and select the THINGPROXY option to enable cross-domain access. EXAMPLE

Most APIs take a device key and resolution parameter. The device key is issued by HelmSmart to link a device to a user account. Interval is a optional numerical time value for which a group of values is returned. Interval starts from current time API is called going backwards. If no Interval parameter is used, the default is 5 minutes from the current time. Options are [1min,2min,5min,10min,15min,30min,1hour,4hour,6hour,8hour,1hour,1day,2day,7day,1month] Resolution is a optional numerical time value in seconds for which a average is calculated and a single value is returned. If a Interval of 10min with a resolution of 60 (sec) is used, 10 data points will be returned. If no Resolution parameter is used, the default is a single data point based on the interval. Some APIs take additional optional parameters INSTANCE is used to identify multiple sensors belonging to the same class - For example Fuel Level or engine speed. It is a numerical value from  0 to 255 with 0 common for single devices or PORT and 1 for STARBOARD. Not all APIs will have a INSTANCE parameter UNITS can be used to convert to Metric [IM] or US Customary [US] units of measure. If IM is used temperature will be in degrees celsius while US will be fahrenheit. The default is US if no parameter is specified. Not all APIs will have a UNITS parameter. Options are [US, Metric, Scientific, Nautical] TIMEZONE converts from GMT (universial) to local time. Options are [UTC, Eastern, Central, Mountain, Pacific, Hawaii] Mode can be used to group data point within a span (interval). Default is to average data based on resolution. If a interval of 1 hour is choosed with resolution of 10 minutes - the average (mean) value for every 10 minutes is trurned. Options are [Mean, Median, Max, Min] TYPE is used for some APIs to select subsets of data. True Wind Direction vs Apparent Wind Direction for example. Options are dependent on the API type. Not all APIs use a TYPE

GPS Location - Lat/Lng in degrees FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_location?apikey=[deviceAPIkey]&Interval=[seconds] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_location?apikey=a5069b96637473d7701fa11eb9baad3d

Wind Data - Speed and direction both True North and Apparent FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_winddata?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Type=[apparent or true]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_winddata?apikey=a5069b96637473d7701fa11eb9baad3d

Environmential - Air temperature, Barometric pressure, and Humidity FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_environmential?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Type=[sea or inside or outside]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_environmental?apikey=a5069b96637473d7701fa11eb9baad3d

Navigation - Speed over Ground, Course over Ground, and Heading FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_nav?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&;Type=[magnetic or true]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_nav?apikey=a5069b96637473d7701fa11eb9baad3d

Battery - Volts, Amps, and Temperature FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_battery?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_battery?apikey=a5069b96637473d7701fa11eb9baad3d

Engine - RPM, Water Temperature, Oil Pressure, Fuel Rate, Alt Volts, Fuel Level, Boost, Hours FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_engine?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Instance=[Number]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_engine?apikey=a5069b96637473d7701fa11eb9baad3d

Engine Aux- boost_pressure,coolant_pressure,fuel_pressure,oil_temp,egt_temperature,fuel_rate_average,instantaneous_fuel_economy,tilt_or_trim= FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_engine_aux?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Instance=[Number]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_engine_aux?apikey=a5069b96637473d7701fa11eb9baad3d

AC Status - AC Volts, Amps, Watts, Energy FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_ac_status?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Type=[UTIL or GEN] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_ac_status?apikey=a5069b96637473d7701fa11eb9baad3d

Switch Status - Open or closed - 16 switches FORMAT: https://helmsmart-freeboard.herokuapp.com/freeboard_status?apikey=[deviceAPIkey]&Interval=[seconds]&Resolution=[seconds]&Units=[IM or US] EXAMPLE: https://helmsmart-freeboard.herokuapp.com/freeboard_status?apikey=a5069b96637473d7701fa11eb9baad3d

www.chetcodigital.com  www.seasmart.net www.netgauges.net www.digitalmarinegauges.com

copyright 2019