[Twitter] 3.0 Twitter Binding (#10241)

* [twitter][WIP] Initial contribution using the 1.x binding as a template, I created a new Twitter Binding. Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> (github: computergeek1507) Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * trying to fix twitter4j dependency stuff Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * add to bundle POM Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * trying to fix build Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * Fixed dependency issues, Got Actions working Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * updating readme Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * fix class name Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * Fixes based on review Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * Cleanup based on review and mvn checks Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * grammar fix Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * remove Apache dependencies Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * added Null Checks based on review Signed-off-by: Scott Hanson <scooter_seh@yahoo.com> * change null check around Signed-off-by: Scott Hanson <scooter_seh@yahoo.com>
2021-09-05 03:33:00 -04:00
parent 0087c8c828
commit b37022c5d7
14 changed files with 769 additions and 0 deletions
--- a/bundles/org.openhab.binding.twitter/README.md
+++ b/bundles/org.openhab.binding.twitter/README.md
@@ -0,0 +1,66 @@
+# Twitter Binding
+
+The Twitter binding allows your home to Tweet 280 characters at a time. It also supports direct messages and tweeting with media.
+
+## Supported Things
+
+```
+account - Twitter Account.
+
+```
+
+## Thing Configuration
+
+The Twitter Account Thing requires you to create a Twitter App in the Twitter Developer Page.
+
+|   Property        | Default | Required | Description                       |
+|-------------------|---------|:--------:|-----------------------------------|
+| consumerKey       |         |   Yes    | Consumer API Key                  |
+| consumerSecret    |         |   Yes    | Consumer API Secret               |
+| accessToken       |         |   Yes    | Access Token                      |
+| accessTokenSecret |         |   Yes    | Access Token Secret               |
+| refresh           | 30      |   No     | Tweet refresh interval in minutes |
+
+
+## Channels
+
+| channel    | type   | description                                    |
+|------------|--------|------------------------------------------------|
+| lasttweet  | String | This channel provides the Latest Tweet message |
+
+
+## Full Example
+
+twitter.things:
+
+```
+Thing twitter:account:sampleaccount [ consumerKey="11111", consumerSecret="22222", accessToken="33333", accessTokenSecret="444444" ]
+
+```
+
+twitter.items:
+
+```
+String sample_tweet   "Latest Tweet: [%s]" { channel="twitter:account:sampleaccount:lasttweet" }
+
+```
+
+## Rule Action
+
+This binding includes rule actions for sending tweets and direct messages.
+
+* `boolean success = sendTweet(String text)`
+* `boolean success = sendTweetWithAttachment(String text, String URL)`
+* `boolean success = sendDirectMessage(String recipientID, String text)`
+
+Examples:
+
+```
+val tweetActions = getActions("twitter","twitter:account:sampleaccount")
+val success  = tweetActions.sendTweet("This is A Tweet")
+val success2 = tweetActions.sendTweetWithAttachment("This is A Tweet with a Pic", file:///tmp/201601011031.jpg)
+val success3 = tweetActions.sendTweetWithAttachment("Windows Picture", "D:\\Test.png" )
+val success4 = tweetActions.sendTweetWithAttachment("HTTP Picture", "http://www.mywebsite.com/Test.png" )
+val success5 = tweetActions.sendDirectMessage("1234567", "Wake Up" )
+
+```