Code Monkey home page Code Monkey logo

weather-plugin-for-elgato-streamdeck's Introduction

Weather Plugin for Elgato StreamDeck

StreamDeck is an awesome productivity tool which allows you almost infinite number of customizations. Therefore, I wanted to develop my own plugin to get updates about the weather.

What is this plugin about?

Weather Plugin gets and displays weather condition on your StreamDeck hourly from AccuWeather. Its dynamic background changes based on the weather. You can see the full list of backgrounds here https://developer.accuweather.com/weather-icons

This plugin is compatible with both Windows and Mac environments. It is written with the StreamDeck's SDK using JavaScript.

Install

Go to https://github.com/tarikguney/weather-plugin-for-elgato-streamdeck/releases and find the latest release. From there, download the com.tarikguney.weather.streamDeckPlugin file to your computer. Simply double click on it and it will be automatically installed and be available on StreamDeck application under Custom actions tab.

Press it for quick updates!

If you press the weather key, you will get the updated weather condition instantly! Otherwise, the weather status will automatically be updated every hour.

Settings

You can change the settings using the property inspector pane on StreamDeck application. Let's look at the image below which shows which settings are available and how the plugin looks when working:

weather-plugin

Title

Do not set the title, and leave it empty! The title is automatically set with the current weather condition including the temperature.

Automatic Refresh

If you want the weather forecast information to be loaded when the actions are loaded, turn on this setting. However, it comes with some caveats: AccuWeather API, which is used in this plugin to retrieve forecast information, allows only 50 requests per day to be made against their servers. Automatic Refresh may end up hitting this limit faster than the manual retrieval. It is advised to be careful with this option. The times when the automatic refresh will be triggered:

  1. StreamDeck is restarting.
  2. Switching profiles.

AccuWeather API Key

Unfortunately, AccuWeather offers only 50 calls per day for each plugin with free AccuWeather accounts. This plugin makes calls to the AccuWeather API to get the hourly weather information to display it on the StreamDeck canvas. Therefore, you need to create your own account and obtain API Key. It is really simple:

  1. Create your account here: https://developer.accuweather.com
  2. Go to https://developer.accuweather.com/user/me/apps and create an App which will be associated with an API Key that you need to copy and paste here.

Check out the image below:

api-key-2

Degree Type

You can set which degree type you'd like to see the temperature in. Currently, the only avaiable options are Celsius and Fahrenheit.

Country Code

Weather Plugin support international weather forecast report. You can choose whichever country you are in. If you are in the US, the Zip Code field will appear. If you are outside of the US, then the City field will appear. For instance, type in London for the United Kingdom.

Zip Code

It is pretty clear as to what it is, however, only the USA Zip Codes are supported currently. This field is also known as Postal Code in different parts of the world.

City

Zip Code is not a universal thing so it is replaced with City when any country other than the US is selected. City and Zip Code fields show up automatically by which country is chosen. If the location you provided cannot be found, you will be notified.

Problem?

Please report your issues here https://github.com/tarikguney/weather-plugin-for-elgato-streamdeck/issues. I will be working on this plugin for a while to make it even better. I would appreciate if you let me know the problems you run into during your usage.

Developed By

@tarikguney with <3

I like my StreamDeck and as a software engineer, it intrigued me to develop something for it. This weather plugin is just a start. I will be adding more plugins, primarily for my own use cases, but I will share them on my Github profile for everyone to use.

Donation?

If you really like this plugin and buy me a book or something, my PayPal account is [email protected].

weather-plugin-for-elgato-streamdeck's People

Contributors

tarikguney avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

weather-plugin-for-elgato-streamdeck's Issues

Unauthorized

Hey! Thanks so much for this. Unfortunately, despite following instructions and putting the API in, it just says "unauthorized" on the Stream Deck tile. Any idea why? :)

Units

Good day.
Tell me please. Is it possible to display the temperature not in Fahrenheit, but in Celsius?

Icon doesn't properly display weather outside

No matter the weather conditions outside, the app always shows the sun with clouds. For example today its snowing and the app shows the correct temp but the icon shows that its cloudy, with a bit of sun.

International stuck on "Updating..."

Doesn't seem to be doing anything if I don't put a zipcode
But countries like UK don't have a numeric zipcode.
If I put "0" it just stays on "Updating" forever.

Setting Hong Kong as the Country and City

Hi there,

Thanks for making this streamdeck plugin! I tried it out and it works when the weather is set to Country: Canada and City: Vancouver.

For Hong Kong I've tried the below variations and it is coming back as "Location not found":

  1. Hong Kong as both the City and Country
  2. Hong Kong as the Country and city as blank
  3. China as the Country and City as Hong Kong
  4. Hong Kong as the Country and City as Sha Tin, Kowloon City, Tsuen Wan (district names)

Is there a specific input that the plugin is looking for? Would it be tied to the expected input from accuweather's API?

Thanks!

Suggestion and request

Please update the instructions to add NOT to type a Title in the Title box rather than stating "no effect". Having text in this field prevents the app from displaying the weather thus completely breaking the App!

It took me a good while to realise that me typing the word "AccuWeather" as the title was the reason why only "AccuWeather" was shown despite following the instructions. LOL.

REQUEST: Is it possible to make a dynamic icon reflecting the weather?

Font Unreadable

Is there a way to change the font size or color. I can't read it half the time.

Show future forecasts

Thanks for creating this plug-in, this is very useful and I use it daily :)

Is it possible to display the future forecast (ex: show the forecast for tomorrow, for 2 days from now, etc), instead of just showing the current weather?

Weather icons are not updating.

The dynamic weather icons do not appear to be updating. I tried poking around with the different API configurations to see if I may have missed something but could not find anything of note. I am thinking this is a possible bug. Thought?

Option to display (or not) the text

Would be nice to add check box to activate or deactivate what is displayed as text. For exemple
[ ] Weather Condition
[ ] Temperature

I would like to only display the temperature as the weather condition is already showed by the icon and I think there is too much text so it's difficult to read.

Thanks
Kevin

Translations

Hi Tarik

I would love to see a feature where you can choose language for the different weathers,
I would love to help with translation for my language and i think we are many more that would help with other translations

the weather is not updated

Hi team,
I followed your guide however the plugin is not working. I see a message on the weather button - "...ted token H...". Unfortunately, I can't see the whole message so it's unclear to me what is the problem. I checked the Elgato logs but no info there. Could you suggest what might be the problem?

Regards

version 2.2 not pulling info until manually clicking

version 2.2 not pulling info until manually clicking
weather username and api key made, data pulls just fine, icons display weather based. F degrees set. Well under the 50 free per day, I just installed it today.
I have multiple buttons on the same streamdeck, at different spots on the same page, for different cities.
one USA based, one International Based icon made.
Issue:
When I click into my weather and clock page which I created on my streamdeck to show multiple cities clocks and weather data (It is not the main page). The icons made from your weather app version 2.2. just have your weather icon with the sun and cloud and blue circle on them instead of pulling the individual cities weather data.
They do update when clicked, but that mildly defeats the purpose and I would love them to auto pull as soon as I open that streamdeck canvas.
Did I do something wrong in setting them up?

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.