Giter Site home page Giter Site logo

dechristopher / meraki-ap-crypto-ticker Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 0.0 185 KB

Uses the Cisco Meraki cloud API to set the SSID of an owned wireless network to the current BTC and/or ETH value.

Home Page: https://github.com/dechristopher

License: MIT License

Shell 0.25% Go 99.75%
go golang cisco meraki access point crypto cryptocurrency btc bitcoin eth ethereum ticker

meraki-ap-crypto-ticker's Introduction

Meraki SSID Crypto Ticker

Ever wanted BTC or ETH prices available at a moment's notice from any WiFi enabled device? Look no further!

alt text

This application uses the Cisco Meraki Cloud APIs to set the SSID of a wireless network you control to the current BTC and/or ETH price with their current upward or downward 24-hour trend and percent change. Any and all cryptocurrency information is pulled from CoinMarketCap's public API and formatted one of many available national currencies.

Modes

The ticker can be run in one of two modes:

  • Cron Mode: run the application as a one-off command in intervals from your system crontab using the -cron flag

  • Service Mode: run the application with no flags and background it so it'll run forever (or until it hits an error and crashes...)

Configuration

First of all, you obviously need control of a Meraki network with at least one active access point. This guide assumes you have knowledge of the Meraki cloud dashboard. It won't teach you how to create new SSIDs or any of that junk.

Make sure you clone this repo to $GOPATH/src/github.com/dechristopher/meraki-ap-crypto-ticker if you plan to build the application yourself otherwise the dependeices won't pull properly. Pre-compiled builds can be found in the releases section. If using a pre-compiled build, skip steps 11 and 12 and just run the application binary after following steps 1-10

That in mind, here are the steps to configuring the application to do our bidding:

  1. Enable the Merkai API at the bottom of the Organization > Settings Page. alt text

  2. Generate an API key on the Edit Account Page alt text

  3. Create a new SSID under the Wireless > SSIDs Page. Name it whatever you want because it'll be renamed promptly by the application. Ensure it's secured properly and implement any firewall rules and traffic shaping as you see fit. This network shouldn't have any devices connect to it ever, so just fire and forget some obnoxiously long PSK.

  4. At this point you need to hit the API to get your Organization ID and your Network ID. Get the organization ID with this query. Be sure to fill in your API key header:

curl -L -H 'X-Cisco-Meraki-API-Key: <key>' -X GET -H 'Content-Type: application/json' 'https://api.meraki.com/api/v0/organizations'
  1. It'll return something like this, note the id field in each object is what we're after:
[
  {
    "id":1234,
    "name":"My org"
  }
]
  1. Use the organization ID you just pulled to find the network ID of the network that contains the SSID you're using for the ticker. Be sure you fill in the API key and organization ID before running the command:
curl -L -H 'X-Cisco-Meraki-API-Key: <key>' -X GET -H 'Content-Type: application/json' 'https://api.meraki.com/api/v0/organizations/[organizationId]
  1. It'll return something like this, note the id field in each object is what we're after:
[
  {
    "id":"N_1234",
    "organizationId":"1234",
    "type": "wireless",
    "name":"My network",
    "timeZone": "US/Pacific",
    "tags": null
  }
]
  1. Now you'll need to find the SSID number of the SSID that'll act as the ticker. This one's easy. Just go in and edit the SSID's settings in the Meraki Cloud Dashboard and the number will be in the last part of the URL as shown here: alt text

  2. At this point we have all the information to allow the application to do its business. Make a copy of the config.example.json and call it config.json. Take your Meraki API key along with the NetworkID and SSID number we gathered and store them in the config.json as such:

{
    "apikey": "API_KEY_HERE",
    "networkid": "NETWORK_ID_HERE",
    "ssidnum": "SSID_NUMBER_HERE",
    ...
}
  1. Enable the cryptocurrencies you'd like to see and set your currency code using the other configuration options in config.json, setting them to true as shown here:
{
    "apikey": "API_KEY_HERE",
    "networkid": "NETWORK_ID_HERE",
    "ssidnum": "SSID_NUMBER_HERE",
    "btc": true,
    "eth": false,
    "currency": "USD",
    "interval": 1
}
Supported currency codes are: "AUD", "BRL", "CAD", "CHF", "CLP", "CNY", "CZK", "DKK", "EUR", "GBP", "HKD", "HUF", "IDR", "ILS", "INR", "JPY", "KRW", "MXN", "MYR", "NOK", "NZD", "PHP", "PKR", "PLN", "RUB", "SEK", "SGD", "THB", "TRY", "TWD", "ZAR"
  1. Before we can compile, we need to ensure we've got all the dependencies. To do this, make sure you're in the project src directory and run:
go get ./...
  1. We're home free! Just build the application using tools/build-(platform).sh and run the application using ./ticker located in the build directory

  2. Within seconds you should see the SSID set to the current crypto prices that you have enabled. They'll be formatted like this:

BOTH Enabled:

[BTC ↑ $13.4k] [ETH ↑ $481]

Only one enabled:

(BTC) ↑ $13,416 [+7.4%]
or
(ETH) ↑ $481 [+9.1%]

Additional Information

By default the application updates the prices once every minute in service mode. This can be changed using the interval configuration option. The value is set in minutes.

Contributing

PLEASE contribute to this project. I know it's a novelty, but it's got some interesting solutions to novelty engineering problems that nobody thinks of...

That said, if there are issues, I'd love to know. Submit an issue or a PR if you're a proactive problem solver.

meraki-ap-crypto-ticker's People

Contributors

dechristopher avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.