Skip to content

Latest commit

 

History

History
153 lines (107 loc) · 5.71 KB

readme.md

File metadata and controls

153 lines (107 loc) · 5.71 KB
Raw

himawari-bg

Set the latest image from Himawari 8 as your desktop background.

npm travis standard

About

Himawari 8 is a geostationary weather satellite deployed by the Japan Meteorological Agency. It takes photographs of Earth every 10 minutes.

himawari-bg is a command line program that lets you set the latest image from the Himawari 8 geostationary satellite as your desktop background.

Desktop Version

This project is now available as a menubar app that automatically sets your background every ten minutes for maximum freshness! Please see hi8 for more info.

Install

Warning: requires ⚡ magick ⚡

If you have homebrew installed, you can use that to quickly install imagemagick and graphicsmagick. The rest of the program can be easily installed with npm.

brew install imagemagick
brew install graphicsmagick
npm install --global himawari-bg

Note: This is alpha quality! Tested only on OSX.

Usage

Command Line

You can run himawari-bg on the command line after it's been installed globally with npm.

If you run himawari-bg with no arguments, it will download the latest image from Himawari-8 and set it as your desktop background.

👉 You have to set the background color of your desktop to black manually if you want it to look as cool as possible.

There are some options available if you'd like to go further:

Usage: himawari-bg [options]

    --outfile, -o         Location to save image. (default: ~/Pictures/himawari-images/$TIMESTAMP.jpg)
    --zoom, -z            The zoom level of the image. Can be 1-5. (default: 2)
    --date, -d            Time of the picture desired. Can also be "latest". (default: "latest")
    --infrared, -i        Capture picture on the infrared spectrum. (default: false)
    --parallel, -p        Parallelize downloads for increased speeds (can be CPU intensive). (default: true)
    --version, -v         Show version information.
    --help, -h            Show help.

Node.js

himawari-bg can also be used programmatically as a node module:

npm install himawari-bg

Here is an example of how it works in node:

var bg = require('himawari-bg')

bg({
  /**
   * The location to save the resulting image.
   * Default: `~/Pictures/himawari-images/${Date.now()}.jpg`
   * @type {String}
   */
  outfile: '/path/to/output/earth.jpg',

  /**
   * The time of the picture desired. If you want to get the latest image, use 'latest'.
   * Default: 'latest'
   * @type {String|Date}
   */
  date: 'latest', // Or new Date() or a date string

  /**
   * The zoom level of the image. Can be 1-5 (default: 2)
   * Each zoom level requires more images to be downloaded and therefore stitched
   * together. Higher zoom yields a higher resolution image.
   * Default: 2
   * @type {Number}
   */
  zoom: 2,

  /**
   * If set to true, an image on the infrared light spectrum will be generated
   * Default: false
   * @type {Boolean}
   */
  infrared: false
})

Acknowledgements

Thanks to celoyd for the inspiring glittering.blue and jakiestfu for creating himawari.js.

Addendum

It turns out himawari.js was inspired by this gist by MichaelPote which basically does the exact same thing as himawari-bg except in a Windows Powershell environment. So I unwittingly made something inspired by something that was inspired by something that does what I did. Internet! ¯\_(ツ)_/¯

Additional Resources

Here are some useful links if you're interested in learning more about the Himawari 8 satellite.

Official

Related Projects

Contributing

Contributions welcome! Please read the contributing guidelines before getting started.

License

ISC