Skip to content

ailequal/zy-stats

Repository files navigation

zy-stats

Fetch Zyxel's stats from the CLI in a pretty way.

Device support

Checkout the different project's tags for the supported devices:

  • 2.0.0 and higher: Zyxel Nebula FWA505
  • 1.1.1 and lower: Zyxel LTE5398-M904

The program might also work with other models, but no guarantee is given (some slightly adjustments might be required).

Setup

To use it, first make sure to have the compatible Node.js version active (nvm execute nvm use).

Beware that zy-stats needs Google Chrome installed on the host machine to perform the log in successfully thorugh Puppeteer.

To use this program, you need to fill the .env file properly (or directly pass the environment variables as CLI arguments). Check the .env.example file for more information.

Here below are listed the basic steps to install and run the program:

git clone https://github.com/ailequal/zy-stats.git
cd zy-stats
chmod +x ./src/app.js # make the script executable
nvm use # set the correct nodejs version
npm install --omit=dev # install only the production dependencies

# fill the .env file with the correct credentials
npx zy-stats # shows stats nicely formatted into the terminal
npx zy-stats --server-url 'http://192.168.1.1' --username admin --password 'password' --interval 5 # without filling the .env file
npm exec zy-stats -- --server-url 'http://192.168.1.1' --username admin --password 'password' --interval 5 # without filling the .env file

# handy alias
alias zy-stats="cd ~/path-to-repos/zy-stats && nvm use && npx zy-stats"

CLI arguments

  • --no-headless: disable browser headless mode (useful for debugging).
  • --server-url: the URL of the Zyxel router.
  • --username: the username to access the Zyxel router.
  • --password: the password to access the Zyxel router.
  • --interval: the interval in seconds to fetch the stats.
  • --log: log the stats into a file in JSON format.

Resources

About

Fetch Zyxel's stats from the CLI.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors