node-red-contrib-awtrix-epl-live 0.4.4 → 0.5.0

package/README.md

@@ -16,27 +16,24 @@ default is no icon
 
 Double-click the node and set:
 
-- **Tracked teams** - a JSON array of team names,
-  matching ESPN's `displayName` exactly (case-insensitive).
-
+- **Tracked teams**
+  A JSON array of team names (case-insensitive).
 ```json
-  ["Liverpool", "Manchester City", "Chelsea"]
+  ["Liverpool", "Manchester City", "Crystal Palace", "Aston Villa"]
 ```
 
-  If a name doesn't match anything ESPN returns for the EPL,
-  a warning is logged to the debug sidebar and that team is skipped -
-  check spelling against ESPN's own team names if a team isn't being
-  tracked as expected.
-  Examples of _valid_ teams names that are normally abbreiviated::
-> ```Wolverhampton Wanderers, Tottenham Hotspur, Brighton & Hove Albion```
+  Team names have been relaxed and more common names are also accepted
+```json
+  ["lfc", "man city", "palace", "villa"]
+```
 
-- **Additional competitions** 
+* **Additional competitions**<br>
   True / False in the dialog options will include or exclude team tracking
   for UEFA competitions.
 
-  - `Champions League`
-  - `Europa League`
-  - `Europa Conference League`
+  * `Champions League`.
+  * `Europa League`.
+  * `Europa Conference League`.
 
 - **Goals icon** (`goalsIcon`) - icon ID used for goal, penalty goal, own
   goal, and disallowed goal notifications. `0` (default) means no icon is
@@ -57,17 +54,11 @@ Double-click the node and set:
   | `43844` | red card |
 
 
-- **Minimum brightness**
-  Your Awtrix device brightness has a direct effect on how visible certain text
-  colours are to read and darker palette colours can also be difficult to 
-  view on the display.
-  The `minimum brightness` dialogue setting is a 'perceived colour' brightness
-  value used to determine if a team colour will be readable on your Awtrix display.
-  All teamname colours are evaluated against this setting, primary and alternate
-  colours are tested in order, if they fall below this threshold and fail the test
-  the team name colour falls back to '#FFFFFF'
-  The default value for this setting is `30`, if you find text colours difficult
-  to read or too many teams names displayed in white then increase this number.
+- **Minimum brightness**<br>
+  Your Awtrix device brightness has a direct effect on how readable certain text colours are and darker palette colours can be difficult to view on the display.<br>
+  The `minimum brightness` dialogue setting is a 'perceived colour' brightness value used to determine if a team colour will be readable on your Awtrix display.<br>
+  All team name colours are evaluated against this value, primary and alternate colours are tested in order, if they fall below this threshold and fail the test the team name colour falls back to '#FFFFFF'.<br>
+  The default value for this setting is `30`. If you find text colours difficult to read or too many team names displayed in white, increase this number.
 
 ## Outputs
 
@@ -78,15 +69,14 @@ This node has three outputs, wire your own downstream nodes to these
 `msg.payload` is one of: `"goal"`, `"disallowed goal"`, `"red card"`,
 or `"full time"`. Penalties and own goals are also reported as `"goal"`
 on this output. The distinction between `goal` events is only reported
-by pin #2 & pin #3..
+by pin #2 & pin #3.
 
 Wire a `switch` node off this output to route each event type to your
 own desired trigger.
 
-Here is an **Alexa Ready** audio clip you can use for **"GOAL"** events to get you started
-```
-"<audio src='https://nr-alexa-sounds.s3.eu-west-2.amazonaws.com/goal.mp3'/>"
-```
+Here is an **Alexa Ready** audio clip you can use for **"GOAL"** events to get you started<br>
+```"<audio src='https://nr-alexa-sounds.s3.eu-west-2.amazonaws.com/goal.mp3'/>"```
+
 
 **Output pin #2 - AWTRIX 3 payload**
 
@@ -101,35 +91,20 @@ Wire this pin straight to one or more `mqtt out` nodes pointed at your AWTRIX 3
 
 ## internally
 
-- **Tracked team colours**
+- **Tracked team colours**<br>
+  Primary & secondary team colours are assessed independently.<br>
+  Home team first to determine if the primary colour is deemed too dark or not viable for AWTRIX (see **Minimum brightness**).<br>
+  Away team colours are assessed in the same manner and checked against the home team resolved colour to avoid the two clashing.
 
-    Primary & secondary team colours are assessed independently.
-    Home team is assessed first:
-    If the primary colour is deemed too dark or not viable for
-    AWTRIX (see **Minimum brightness** above), the alternate is
-    used, if that fails the fallback is to default to `#FFFFFF`.
-    Away team colours:
-    Also assessed in the same manner and also checked against
-    the home teams resolved colour to avoid the two clashing.
-
-- **Node Status**
-
-    The node will show any upcoming matches for tracked teams:
+- **Node Status**<br>
+    The node will show any upcoming matches for tracked teams only:
 
     - **"nothing upcoming"** - none of your tracked teams have any immediate matches.
-    - **"next match xxxx-xx-xx"** - date of the next match from your tracked teams.
+    - **"next match xxxx-xx-xx"** - date of the next match from your tracked teams list.
     - **"kick off shortly"** - a match is about to begin.
     - **"live - in play"** - match underway and actively polling for live data.
-<br>
-- **Block event dispatch queue**
-
-    block delivery of payloads, designed so multiple
-    events don't overwrite each other.
-
-    finished matches are removed 60+ minutes after fulltime
 
 ## Known limitations
 
 **Currently** team names are *ONLY* resolved against the Premier League.
 Non EPL teams cannot currently be added to Tracked Teams by name.
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-awtrix-epl-live",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "description": "awtrix live football",
   "author": "evans.l",
   "license": "MIT",