{"id":32486256,"url":"https://github.com/raiseandfall/tweet-alert","last_synced_at":"2025-10-27T05:40:45.474Z","repository":{"id":17024896,"uuid":"19788957","full_name":"raiseandfall/tweet-alert","owner":"raiseandfall","description":"A simple Arduino/NodeJS installation who alerts you when somebody tweets.","archived":false,"fork":false,"pushed_at":"2014-05-23T23:37:58.000Z","size":284,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-08-02T03:11:38.683Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raiseandfall.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-14T17:23:05.000Z","updated_at":"2023-08-02T03:11:38.684Z","dependencies_parsed_at":"2022-08-28T06:10:38.639Z","dependency_job_id":null,"html_url":"https://github.com/raiseandfall/tweet-alert","commit_stats":null,"previous_names":[],"tags_count":2,"template":null,"template_full_name":null,"purl":"pkg:github/raiseandfall/tweet-alert","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiseandfall%2Ftweet-alert","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiseandfall%2Ftweet-alert/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiseandfall%2Ftweet-alert/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiseandfall%2Ftweet-alert/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raiseandfall","download_url":"https://codeload.github.com/raiseandfall/tweet-alert/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raiseandfall%2Ftweet-alert/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281222554,"owners_count":26464000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-27T05:40:43.733Z","updated_at":"2025-10-27T05:40:45.469Z","avatar_url":"https://github.com/raiseandfall.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"tweet-alert\n===========\n\nA simple Arduino/NodeJS installation who triggers something when somebody tweets. e.g. flashing a led, etc...\n\nUses [Johnny-five](https://github.com/rwaldron/johnny-five) \u0026 [user-stream](https://github.com/aivis/user-stream) for Twitter streaming API.\n\n## INSTALL\n\n```shell\n$ git clone git@github.com:raiseandfall/tweet-alert.git \u0026\u0026 cd tweet-alert\n$ npm install\n```\n\n## BASIC EXAMPLE\n\nThis example flashes a LED every 250ms for 15s when a specific user has tweeted.\n\n#### Arduino\n![Breadboard](bb.png)\n\n#### JS\n\n```javascript\nvar TweetAlert = require('./src/tweet-alert'),\n    five = require('johnny-five'),\n    app,\n    board = new five.Board(),\n    led;\n\n// Init\napp = new TweetAlert({\n  consumer_key: 'xxxxxxxxxxxxxxxx',\n  consumer_secret: 'xxxxxxxxxxxxxxxx',\n  access_token_key: 'xxxxxxxxxxxxxxxx',\n  access_token_secret: 'xxxxxxxxxxxxxxxx',\n  screen_name: ['kexp', 'rue89']\n});\n\n// Wait for the board to be ready\nboard.on('ready', function() {\n  led = new five.Led(13);\n  led.off();\n\n  // Start to track\n  app.track();\n\n  // Listen to tweet alert\n  app.on('tweet', function(data) {\n    console.log('New Tweet :: ', data.text, ' by ', data.user);\n\n    led.strobe(250);\n    setTimeout(function() {\n    \tled.off();\n    }, 15000);\n  });\n});\n```\n\n## TWEET READER EXAMPLE\n\n[Source code](https://github.com/raiseandfall/tweet-alert/blob/master/example.js).\n\n\n## CONTRIBUTE\n\n```shell\n# Start nodemon\n$ gulp dev\n\n# Build sources\n$ gulp build\n```\n\n## API\n\n#### Configuration\n- ```consumer_key``` - `String` - Twitter app consumer key\n- ```consumer_secret``` - `String` - Twitter app consumer secret\n- ```access_token_key``` - `String` - Twitter app access token key\n- ```access_token_secret``` - `String` - Twitter app access tokensecret\n- ```screen_name``` - `String|Array` - Twitter screen name(s) to filter. Can be an empty string (all the users followed = your entire Twitter feed), one user or an array of users.\n\n#### Methods\n- ```track``` - starts tracking Twitter account\n- ```untrack``` - stops tracking; closes Twitter stream\n\n#### Events\n- ```tweet``` - fired when new tweet streamed. Sends back a data object :\n```javascript\n{\n    text: 'Tweet',\n    screen_name: 'screen_name',\n    name: 'Firstname Lastname',\n    id: '123456'\n}\n```\n\n- ```close``` - fired when Twitter Stream connection has closed\n- ```error``` - fired when error has occured\n\n\n## License\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraiseandfall%2Ftweet-alert","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraiseandfall%2Ftweet-alert","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraiseandfall%2Ftweet-alert/lists"}