About MMM-TwitterLists

I’ve been trying get a few Twitter modules installed on my MagicMirror installation, and most have been abandoned for years. Twitter updated their API authentication a few months ago, and that ended up breaking them.

I also use my MM more as a 24/7 dashboard of news and information, so I wanted a list of the most recent tweets to show up so I could just glance at the screen and get an idea of current tweets on a topic. I use lists to organize my twitter timeline, so that was a natural way for me to access tweets.

Link To Github

MMM-TwitterLists

Preview

Installation

Please refer to the ReadME on Github for the most up to date information, but to get started, you simply need to install the module and update the config with your listID and bearer token from twitter:

Install the Module

To install the module, clone the repository into your magic mirror modules folder, register for an API key, and configure the module on your MM instance :

git clone https://github.com/mmtsweng/MMM-TwitterLists
cd MMM-TwitterLists
npm install --production

Get a bearer token from Twitter

You need to register with twitter for a developer account, create a Project, and a Twitter App. This will generate API keys for you to use in your configuration.

MMM-TwitterLists uses application only authentication, since it is only interested in publicly available, non-user context data. This greatly simplifies the authentication process, as you only need to supply a valid bearer token in the header of the API request.

Configure MMM-TwitterLists

A minimal configuration only requires a Twitter List ID and a Bearer Token to render:

{
    module: "MMM-TwitterLists",
    header: "Twitter Lists",
    position: "top_center",
    config: {
        twitterListId: "1569757713495920642",
        twitterBearerToken: "{Bearer Token}" //replace with your own private bearer token
    }
}

All other configuration options are documented in the github readme file, and very few will be needed for most instances.

The one optional change that might be of use, is the maximum number of tweets to pull and render. The default is 10 tweets. To change it, simply override the twitterUrl option, updating the max_results parameter in the API call. Be careful not to change any of the other parameters, as they are used by the module.

For example, to return 5 tweets, instead of 10, your configuration section would look like this:

{
    module: "MMM-TwitterLists",
    header: "Twitter Lists",
    position: "top_center",
    config: {
        twitterListId: "1569757713495920642",
        twitterBearerToken: "{Bearer Token}",
        twitterURL: "https://api.twitter.com/2/lists/{id}/tweets?&tweet.fields=attachments,author_id,created_at,text&expansions=attachments.media_keys,author_id&media.fields=preview_image_url,type,url&user.fields=profile_image_url&max_results=5"
        }
}

I built this module more by need than anything else – the Seattle area where I live has been hit by some relatively severe weather the past few days, that have caused real problems for the area. While I wasn’t caught off-guard this time, I realized that the MM weather modules I had didn’t emphasize local warnings, alerts, and weather watches. So I built a module expressly for solving that problem:

MMM-NOAAAlerts
Special Weather Statement:

Flood Warning:

USING THE MODULE

Github Link

Standard installation:

git clone https://github.com/mmtsweng/MMM-NOAAAlerts
cd MMM-NOAAAlerts
npm install 

Basic configuration:

{
  module: "MMM-NOAAAlerts",
  position: "top_bar",
  config: {
      userAgent: "Magic Mirror (xxxxxxxxxxxx@gmail.com)" //Custom contact information
      APIURL: "https://api.weather.gov/alerts/active?point=47.593,-122.333", //See below for other options
      debug: false, // [Optional] Print extended debugging logs to the console
      rotateInterval: 20*1000, // [Optional] How often to switch to the next alert/alarm
      updateInterval: 30*60*1000, // [Optional] How often to ping the API for more data
      }
},

NOAA provides a free API to retrieve weather alerts, which this API uses. There is no registration required.
There are multiple ways to set the forecast area, and NOAA provides through documentation if you need extensive help. But the basics are

• By State: https://api.weather.gov/alerts/active?area={state}
• By Zone: https://api.weather.gov/alerts/active?zone={zone}
• By Lat/Long: https://api.weather.gov/points/{latitude},{longitude}
• By Grid: https://api.weather.gov/gridpoints/{office}/{grid X},{grid Y}/forecast

NOAA requires that a User-Agent header be provided. Please set your own custom agent in the config with unique contact information (the suggested header is: User-Agent: (myweatherapp.com, contact@myweatherapp.com) , so following that format makes sense.

This is still very much a work in progress. I have spent very little time styling it, and I haven’t even put together the README file yet (I’m going to steal this post, actually!). But I have had it running for the past 2 days with no major issues. So far I’ve only tested it in the top bar section. If anyone else wants to try it and provide feedback I’ll be actively improving it.

@KI6UVE I ran into the same problem, and decided to build my own module. This one uses public lists to display tweets. I’ve had it running on my MM for a few days without issue, but it’s still new and raw, so there are probably bugs I haven’t come across.

I’ll post something in showcase to put together a support thread.

@sdetweil I was just trying to be extra obvious and explicit for @svencarree :)

@OldSunGuy

Oh, I’m glad you guys found and were able to use MMM-NOAAAlerts!

Sorry I didn’t advertise it well enough. Ping me direct if you have any issues.

@01ZerosOnes01 It doesn’t look as nice as the screenshot on the MMM-DarkSkyRadar github, but I’ve been using MMM-RAIN-MAP, and it’s been working well.

Current screenshot:

@svencarree
I got multiple google calendars to display, including subscribed calendars. Try using the two links here (I had more luck with the secret address, and just use that as the default) in settings:

@OldSunGuy

Oh, I’m glad you guys found and were able to use MMM-NOAAAlerts!

Sorry I didn’t advertise it well enough. Ping me direct if you have any issues.

@Mesohilo Good call-out on the media thumbnails.

I’ve updated the module to add a config setting to show/hide the media thumbnails:

	config: {
                ... //other configs
		showPictures: false,
	}

@Mesohilo Glad you like it. I’ve been using it for a while and like it too.

I’ve updated the Readme to fix the spaces issue. I had added them for wordwrap on Github. :)

@01ZerosOnes01 It doesn’t look as nice as the screenshot on the MMM-DarkSkyRadar github, but I’ve been using MMM-RAIN-MAP, and it’s been working well.

Current screenshot:

@sdetweil I was just trying to be extra obvious and explicit for @svencarree :)

@svencarree
I got multiple google calendars to display, including subscribed calendars. Try using the two links here (I had more luck with the secret address, and just use that as the default) in settings:

I built this module more by need than anything else – the Seattle area where I live has been hit by some relatively severe weather the past few days, that have caused real problems for the area. While I wasn’t caught off-guard this time, I realized that the MM weather modules I had didn’t emphasize local warnings, alerts, and weather watches. So I built a module expressly for solving that problem:

MMM-NOAAAlerts
Special Weather Statement:

Flood Warning:

USING THE MODULE

Github Link

Standard installation:

git clone https://github.com/mmtsweng/MMM-NOAAAlerts
cd MMM-NOAAAlerts
npm install 

Basic configuration:

{
  module: "MMM-NOAAAlerts",
  position: "top_bar",
  config: {
      userAgent: "Magic Mirror (xxxxxxxxxxxx@gmail.com)" //Custom contact information
      APIURL: "https://api.weather.gov/alerts/active?point=47.593,-122.333", //See below for other options
      debug: false, // [Optional] Print extended debugging logs to the console
      rotateInterval: 20*1000, // [Optional] How often to switch to the next alert/alarm
      updateInterval: 30*60*1000, // [Optional] How often to ping the API for more data
      }
},

NOAA provides a free API to retrieve weather alerts, which this API uses. There is no registration required.
There are multiple ways to set the forecast area, and NOAA provides through documentation if you need extensive help. But the basics are

• By State: https://api.weather.gov/alerts/active?area={state}
• By Zone: https://api.weather.gov/alerts/active?zone={zone}
• By Lat/Long: https://api.weather.gov/points/{latitude},{longitude}
• By Grid: https://api.weather.gov/gridpoints/{office}/{grid X},{grid Y}/forecast

NOAA requires that a User-Agent header be provided. Please set your own custom agent in the config with unique contact information (the suggested header is: User-Agent: (myweatherapp.com, contact@myweatherapp.com) , so following that format makes sense.

This is still very much a work in progress. I have spent very little time styling it, and I haven’t even put together the README file yet (I’m going to steal this post, actually!). But I have had it running for the past 2 days with no major issues. So far I’ve only tested it in the top bar section. If anyone else wants to try it and provide feedback I’ll be actively improving it.

Thanks! I do see that error. I’ve added a ton more logging information to my local instance, and have restarted MM. If it happens again I’ll have more data to go by.

When it hits that condition, it doesn’t send a notification, so that probably breaks the timer interval, though I’m not seeing yet how that happens. I’ll continue to debug.

Sorry to necropost to a 2 year old thread.

But I’m seeing the same issue, on the same module. Anyone know why this happens?

I have confirmed that it’s making the proper requests to the API, and the API is responding with a valid JSON object.

If I restart MM, the standings show up again, but after some period of time, it just disappears. I do use MMM-Carousel to create slides.

I’ll continue to debug.

About MMM-TwitterLists

I’ve been trying get a few Twitter modules installed on my MagicMirror installation, and most have been abandoned for years. Twitter updated their API authentication a few months ago, and that ended up breaking them.

I also use my MM more as a 24/7 dashboard of news and information, so I wanted a list of the most recent tweets to show up so I could just glance at the screen and get an idea of current tweets on a topic. I use lists to organize my twitter timeline, so that was a natural way for me to access tweets.

Link To Github

MMM-TwitterLists

Preview

Installation

Please refer to the ReadME on Github for the most up to date information, but to get started, you simply need to install the module and update the config with your listID and bearer token from twitter:

Install the Module

To install the module, clone the repository into your magic mirror modules folder, register for an API key, and configure the module on your MM instance :

git clone https://github.com/mmtsweng/MMM-TwitterLists
cd MMM-TwitterLists
npm install --production

Get a bearer token from Twitter

You need to register with twitter for a developer account, create a Project, and a Twitter App. This will generate API keys for you to use in your configuration.

MMM-TwitterLists uses application only authentication, since it is only interested in publicly available, non-user context data. This greatly simplifies the authentication process, as you only need to supply a valid bearer token in the header of the API request.

Configure MMM-TwitterLists

A minimal configuration only requires a Twitter List ID and a Bearer Token to render:

{
    module: "MMM-TwitterLists",
    header: "Twitter Lists",
    position: "top_center",
    config: {
        twitterListId: "1569757713495920642",
        twitterBearerToken: "{Bearer Token}" //replace with your own private bearer token
    }
}

All other configuration options are documented in the github readme file, and very few will be needed for most instances.

The one optional change that might be of use, is the maximum number of tweets to pull and render. The default is 10 tweets. To change it, simply override the twitterUrl option, updating the max_results parameter in the API call. Be careful not to change any of the other parameters, as they are used by the module.

For example, to return 5 tweets, instead of 10, your configuration section would look like this:

{
    module: "MMM-TwitterLists",
    header: "Twitter Lists",
    position: "top_center",
    config: {
        twitterListId: "1569757713495920642",
        twitterBearerToken: "{Bearer Token}",
        twitterURL: "https://api.twitter.com/2/lists/{id}/tweets?&tweet.fields=attachments,author_id,created_at,text&expansions=attachments.media_keys,author_id&media.fields=preview_image_url,type,url&user.fields=profile_image_url&max_results=5"
        }
}