Skip to content

A module for the MagicMirror2 that graphs low and high tide predictions for a given tide station, and measured data as it is reported from NOAA.

License

Notifications You must be signed in to change notification settings

crice009/MMM-NOAATides

Repository files navigation

MMM-NOAATides

This an extension for the MagicMirror.

Alt text

The module graphs low and high tide predictions for a given tide stations, and measured data as it is reported. Data is pulled from NOAA-tidesandcurrents. Data is a free service - paid by tax dollars. Go USA!

Dependencies

  • An installation of MagicMirror2
  • Packages: chartjs & node-fetch, both loaded via npm install

Installation

  1. Clone this repo into ~/MagicMirror/modules directory.

  2. cd MMM-NOAATides

  3. npm install

  4. Configure your ~/MagicMirror/config/config.js:

      {
        module: "MMM-NOAATides",
        position: "top_right", //put this below a weather module in config.js, and so it is on screen
        config: {
          stationID: 8518750, // this happens to be the station at 'the Battery' in NYC, USA
          datum: "MSL", // "mean sea level"
          time: "lst_ldt", // local standard time/ daylight time
          units: "english", // or "metric"
        }
      }
    

Configuration options

The following properties can be configured:

Option Values Description
stationID REQUIRED The ID number of the NOAA tide station you want to graph. You can find your local tide station, and the code you want here. https://tidesandcurrents.noaa.gov/map/
datum OPTIONAL The selected is "mean sea level." You probably want to stick to that option.
time OPTIONAL Local standard time/ daylight time -- other options available, but you don't want them...
units OPTIONAL This defaults to whatever your Magic Mirror units are set to be. The only reason to use is to switch to metric tide-heights.
language OPTIONAL Sorry, I didn't do anything with this yet...
--- --- ---
chartJS.animationDuration OPTIONAL milliseconds to expand datapoints away from zero on the X axis, every rendering
chartJS.aspectRatio OPTIONAL 1=square graph, >1=wider, <1=taller
chartJS.fillBetween OPTIONAL boolean colors-in area between predicted and measured data
chartJS.measured.backgroundColor OPTIONAL Graph color options read more
chartJS.measured.borderColor OPTIONAL Graph color options read more
chartJS.measured.pointBorderColor OPTIONAL Graph color options read more
chartJS.measured.pointBackgroundColor OPTIONAL Graph color options read more
chartJS.predicted.borderColor OPTIONAL Graph color options read more
chartJS.predicted.pointBorderColor OPTIONAL Graph color options read more
chartJS.predicted.pointBackgroundColor OPTIONAL Graph color options read more

About

A module for the MagicMirror2 that graphs low and high tide predictions for a given tide station, and measured data as it is reported from NOAA.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published