mariusbreivik / netatmo

A tiny CLI written in go-lang used to retrieve data from Netatmo Weather API. The CLI is based on the cobra framework

netatmo

• 📖 describe()
• 🧑‍💻 use()
  • 🌡 temp
  • 🎧 noise
  • 🌫 co2
  • 💦 humidity
  • ⚙️ firmware
  • 📶 wifi
  • 🕐 lastupgrade
  • 📈 pressure
• 📜 develop()
• 💾 install()

📖 describe()

netatmo is a tiny CLI based on the cobra framework written in go-lang. Its mostly just for fun, but the purpose is retrieving and displaying data in the command line from netatmo weather api.

🧑‍💻 use()

netatmo has several subcommands which can be used to get different data from your Netatmo Weather Station. There is still some work remaining to get all commands working.

🌡 temp

$ netatmo temp -o, --outdoor | -i , --indoor

🎧 noise

$ netatmo noise

🌫 co2

$ netatmo co2

💦 humidity

$ netatmo humidity

⚙️ firmware

$ netatmo firmware

📶 wifi

$ netatmo wifi

🕐 lastupgrade

$ netatmo lastupgrade

📈 pressure

$ netatmo pressure

📜 develop()

• You need to have your own Netatmo Weather Station in order to use this CLI
• Sign up at netatmo and create an app to get clientId and clientSecret in order to retrieve data from your Netatmo Weateher Station through the API.

💾 install()

• Make sure go is installed
• Clone this repo
• install dependencies and build:

$ go install && go build

• create config file called $HOME/.netatmo.yaml with this content:

netatmo:
  clientID: YOUR_CLIENT_ID
  clientSecret: YOUR_CLIENT_SECRET
  username: YOUR_NETATMO_USERNAME
  password: YOUR_NETATMO_PASSWORD

• If everything is correct should be able to run:

$ netatmo

Uses the Netatmo Weatherstation API to get your indoor/outdoor
temperature, co2 level, nois level, humidity, firmware data, wifi signal strength,
and more

Usage:
  netatmo [flags]
  netatmo [command]

Examples:
netatmo temp --indoor

Available Commands:
  co2         read co2 data from netatmo station
  firmware    read firmware data from netatmo station
  help        Help about any command
  humidity    read humidity data from netatmo station
  noise       read noise data from netatmo station
  temp        read temperature data from netatmo station
  wifi        read wifi data from netatmo station
  pressure    read pressure data from netatmo station

Flags:
      --config string   config file (default is $HOME/.netatmo.yaml)
  -d, --debug           debug logging
  -h, --help            help for netatmo

Use "netatmo [command] --help" for more information about a command.