GithubHelp home page GithubHelp logo

mlbonniec / mmm-coinbase Goto Github PK

View Code? Open in Web Editor NEW
12.0 4.0 11.0 821 KB

A module for Michael Teeuw's MagicMirror project that displays your crypto-currencies Coinbase balance.

Home Page: https://magicmirror.builders/

License: MIT License

JavaScript 76.04% CSS 23.96%
coinbase magic-mirror magic-mirror-modules bitcoin cryptocurrency crypto-currencies mmm-coinbase coinbase-api magicmirror

mmm-coinbase's Introduction

MMM-Coinbase

A module for Michael Teeuw's MagicMirror project that displays your crypto-currency Coinbase balance.
The module is now compatible with all crypto-currencies available on Coinbase. However, only Bitcoin and Ethereum icons are available. For the other crypto-currencies, the currency symbol is displayed. (e.g. LTC for Litecoin)

How it works

After installing the module and configuring the Coinbase API with your account, the module displays your crypto-currency balance in real time. It is updated every 5 seconds.

Screenshot

Prerequisites

  • MagicMirror2
  • Node.js
  • npm
  • Coinbase account

Installing

Installing the module is quite straight forward

Step 1 - Install the module

cd ~/MagicMirror/modules
git clone https://github.com/mlbonniec/MMM-Coinbase.git
cd MMM-Coinbase
npm install

Step 2 - Create your coinbase API keys

"Step-1" "Step-2" "Step-3"

Go to API Access

Click + New API Key

Check BTC Wallet (or LTC Wallet, ETH ...) and wallet:accounts:read

"Step-4" "Step-5"

Click Create

Copy API Key and API Secret Key

Step 3 - Add module to ~MagicMirror/config/config.js

Add this configuration into config.js file's

{
    module: "MMM-Coinbase",
    position: "top_left", // put it where you want it
    header: "Coinbase", // optional
        config: {
            apiKey: "YOUR API KEY", // the key previously copied
            apiSecret: "YOUR API SECRET KEY",
            wallet: ["BTC", "LTC"], // list of currencies to display
            icons: true, // currently only Ethereum and Bitcoin supported
            label: false  // shows currency labels (e.g. BTC, ETH and so on)
        }
}

Updating

Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:

git pull
npm install

Configuring

Here is the configurable part of the module

Option Description
apiKey API Key from Coinbase.

Type: string REQUIRED
Example:1iO5VjY2bdC3HucJ
Default value: none
apiSecret API Secret Key from Coinbase.

Type: string REQUIRED
Example:OwABcDaA5fxK3QTV3gjwvOk358juuXti
Default value: none

Use

Now you can fully use MagicMirror and the MMM-Coinbase module to display your wallets ! Enjoy it well !

Contributing

If you find any problems, bugs or have questions, please open a GitHub issue in this repository.

Contributors

  • nabbl thank you for your great work!

mmm-coinbase's People

Contributors

kurtern84 avatar mlbonniec avatar nabbl avatar swadedotexe avatar weeskybdw avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

mmm-coinbase's Issues

coinbase0 USD showing even when individual crypto reporting

Hello, after I put in the API keys, the coin amounts work flawlessly, with each coin showing the bought amount. However, the header "Coinbase" with the wallet in USD does not work, showing "Coinbase0 USD". Both keys are in the config, as the individual coins work. Maybe the API updated?

I hope you can fix it :)

Amount stuck on 0

Hello,
I noticed that the amount of the bitcoin is stock on 0 (init of the variable bal in the node_helper) whereas I entered my API keys

Is this normal?
(Sorry for my English I'm French)

No values displayed

I love this module. Since a few days, the values are not updating.. The environment didn't change. Could you please help.

Show value instead of curency amount

Would it be possible to set i.e. XLM 35,52 EU, instead of 124,2530943 XLM?
I want to see how much my currency is worth, not the amount of coins I got.
Or both would be great.

Error: ETIMEDOUT

[2020-11-13 11:47:12.988] [ERROR] Whoops! There was an uncaught exception...
[2020-11-13 11:47:12.990] [ERROR] Error: ETIMEDOUT
at Timeout._onTimeout (/home/pi/MagicMirror/modules/MMM-Coinbase/node_modules/request/request.js:846:19)
at listOnTimeout (internal/timers.js:531:17)
at processTimers (internal/timers.js:475:7) {
code: 'ETIMEDOUT',
connect: true
}

Bug: module shows only "0"

Hey guys,
I have installed the module. After starting magicmirror there will be only shown "0" and not the amount of my coins and the ohter stuff...
Any ideas ?

Dont work?

Hi, I've created my API without any problem and I added to the config the API KEY, and the API Secret.
Then i set BTC as my coin and when I restart the mirror I can only see: COINBASE .................0

This is my module config:

module: "MMM-Coinbase",
position: "top_left", // put it where you want it
header: "Coinbase", // optional
classes: 'default everyone',
config: {
apiKey: "MYAPIKEY", // the key previously copied
apiSecret: "MYAPISECRET",
wallet: ["BTC"], // list of currencies
icons: true, // currently only Ethereum and Bitcoin supported
label: false // shows currency labels (e.g. BTC, ETH and so on)
}

I dont know where is the problem.
Can you confirm its working nowadays?
Thank you.

XTZ dzn't work - solution

Only XTZ will not appear. Any idea?
Edit: OXT too😕

{
module: "MMM-Coinbase",
position: "top_center",
header: "Coinbase",
config: {
apiKey: "MY CORRECT KEY",
apiSecret: "MY CORRECT API SECRET KEY",
wallet: ["NU", "XTZ", "FIL", "COMP", "OXT",],
icons: true,
label: false
}
}

Screenshot 2020-12-16 134652

Portefeuille en EUR

Hello,

Thank you for this great module

Is it possible to display the amount of the Portfolio in EUR instead of the bitcoin amount?

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.