0.0.4 • Published 11 years ago

mhl-buoy-data v0.0.4

Weekly downloads
2
License
-
Repository
github
Last release
11 years ago

MHL Buoy Data

build status

MHL buoys track swell conditions off the coast of NSW Australia. This will parse their GIF graphs so the data can be used in other ways.

Learn more about these graphs here: http://new.mhl.nsw.gov.au/data/realtime/wave/

Turns this

Sydney buoy

Into this

{ 
  direction: 138.46, 
  hsig: 0.97, 
  hmax: 1.75, 
  tsig: 5.94, 
  tp1: 5.1 
}

I'm only interested in the latest readings, that's what this object outlines.

Usage

Here's a little bit from the tests showing how it's used.

var parseMHLGraph = require('../')
var assert        = require('assert')

parseMHLGraph('./test/fixtures/syddir-1.gif', function(conditions) {
  assert.equal(conditions.direction, 138.46) // Degrees true north
  assert.equal(conditions.hmax, 1.75)        // Metres
  assert.equal(conditions.hsig, 0.97)        // Metres
  assert.equal(conditions.tp1, 5.1)          // Seconds
  assert.equal(conditions.tsig, 5.94)        // Seconds
})

Also...

  • This is certainly a work in progress and there's a good chance that values are slightly off. Things will be ironed out over time.
  • There's a little GIF decoder in here too. It was hastily hacked and the code is a horror, but that'll improve when I extract it. Big thanks to the GIF spec and https://github.com/shachaf/jsgif. JS Gif in particular was handy, and I pulled across some things like the LZW decoder.

License

MHL Buoy Data is released under the MIT license.

0.0.4

11 years ago

0.0.3

11 years ago

0.0.2

11 years ago

0.0.1

11 years ago