node-red-contrib-antenna-genius 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -31
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,57 +1,61 @@
1
1
  # node-red-contrib-antenna-genius
2
2
  Antenna Genius Control and Monitoring Nodes
3
3
 
4
+ ![image](https://user-images.githubusercontent.com/7033002/148489952-edbf4307-ab57-4801-b963-337c03b2b095.png) ![image](https://user-images.githubusercontent.com/7033002/148489672-9e2c03e0-a968-4c2f-9dc7-923c5423fad7.png)
5
+
6
+ ![image](https://user-images.githubusercontent.com/7033002/148489839-dba01b50-9f02-4a23-a521-41db6acc96a8.png)
7
+
4
8
  ## antenna-genius-band-labels
5
9
 
6
10
  Returns the current band labels for radio A and radio B.
7
11
 
8
12
  ### Properties
9
13
 
10
- `Server (antenna genius server)` select antenna genius server to use.
14
+ `Server (antenna genius server)`: select antenna genius server to use.
11
15
 
12
16
  ### Outputs
13
17
 
14
- `payload.bandLabelA (string)` is the current band for Radio A as a string. For example `12m`.
18
+ `payload.bandLabelA (string)`: is the current band for Radio A as a string. For example `12m`.
15
19
 
16
- `payload.bandLabelB (string)` is the current band for Radio B as a string. For example `10m`.
20
+ `payload.bandLabelB (string)`: is the current band for Radio B as a string. For example `10m`.
17
21
 
18
22
  ## antenna-genius-antenna-status
19
23
 
20
24
  ### Properties
21
25
 
22
- `Server (antenna genius server)` select antenna genius server to use.
26
+ `Server (antenna genius server)`: select antenna genius server to use.
23
27
 
24
- `Antenna Number (integer)` Antenna number to get status for. Valid values are from 1 up to 32 (8 for one, 16 for two, 24 for three and 32 for four interconnected Antenna Geniuses).
28
+ `Antenna Number (integer)`: Antenna number to get status for. Valid values are from 1 up to 32 (8 for one, 16 for two, 24 for three and 32 for four interconnected Antenna Geniuses).
25
29
 
26
30
  ### Outputs
27
31
 
28
32
  Port 1: Status for Radio A antenna.
29
33
 
30
- `payload.selected (boolean)` this is the currently selected antenna for Radio A on the current band.
34
+ `payload.selected (boolean)`: this is the currently selected antenna for Radio A on the current band.
31
35
 
32
- `payload.enabled (boolean)` this antenna can be selected for use by Radio A on the current band.
36
+ `payload.enabled (boolean)`: this antenna can be selected for use by Radio A on the current band.
33
37
 
34
- `payload.name (string )` the name of this antenna.
38
+ `payload.name (string )`: the name of this antenna.
35
39
 
36
- `payload.background (string)` the suggested background color for the current antenna state.
40
+ `payload.background (string)`: the suggested background color for the current antenna state.
37
41
 
38
- `enabled (boolean)` same as `payload.enabled`.
42
+ `enabled (boolean)`: same as `payload.enabled`.
39
43
 
40
- `topic (string)` string that can be used to ativate this antenna using the `activate-antenna` node.
44
+ `topic (string)`: string that can be used to ativate this antenna using the `activate-antenna` node.
41
45
 
42
46
  Port 2: Status for Radio A antenna.
43
47
 
44
- `payload.selected (boolean)` this is the currently selected antenna for Radio B on the current band.
48
+ `payload.selected (boolean)`: this is the currently selected antenna for Radio B on the current band.
45
49
 
46
- `payload.enabled (boolean)` this antenna can be selected for use by Radio B on the current band.
50
+ `payload.enabled (boolean)`: this antenna can be selected for use by Radio B on the current band.
47
51
 
48
- `payload.name (string )` the name of this antenna.
52
+ `payload.name (string )`: the name of this antenna.
49
53
 
50
- `payload.background (string)` the suggested background color for the current antenna state.
54
+ `payload.background (string)`: the suggested background color for the current antenna state.
51
55
 
52
- `enabled (boolean)` same as `payload.enabled`.
56
+ `enabled (boolean)`: same as `payload.enabled`.
53
57
 
54
- `topic (string)` string that can be used to ativate this antenna using the `activate-antenna` node.
58
+ `topic (string)`: string that can be used to ativate this antenna using the `activate-antenna` node.
55
59
 
56
60
  ### Details
57
61
 
@@ -63,15 +67,15 @@ Set the antenna defined in topic as active.
63
67
 
64
68
  ### Properties
65
69
 
66
- `Server (antenna genius server)` select antenna genius server to use.
70
+ `Server (antenna genius server)`: select antenna genius server to use.
67
71
 
68
72
  ### Inputs
69
73
 
70
- `topic (string)` Selection string for antenna. For example `"1;5"` for Radio A, antenna 5.
74
+ `topic (string)`: Selection string for antenna. For example `"1;5"` for Radio A, antenna 5.
71
75
 
72
76
  ### Details
73
77
 
74
- See the `antenna-status` node for more information.
78
+ See the `antenna-status`: node for more information.
75
79
 
76
80
  ## antenna-genius-server
77
81
 
@@ -79,18 +83,12 @@ Antenna Genius shared connection configuration.
79
83
 
80
84
  ### Configuration
81
85
 
82
- `Host (string)` Antenna Genius host name or IP address.
83
-
84
- `Port (integer)` Antenna Genius port number.
85
-
86
- `Disabled Background (string)` Background color to use for an antenna that is disabled.
87
-
88
- `Active Background (string)` Background color to use for an antenna that is active (e.g. can be selected).
89
-
90
- `Selected Background (string)` Background color to use for and antenna that is selected.
91
-
92
-
86
+ `Host (string)`: Antenna Genius host name or IP address.
93
87
 
88
+ `Port (integer)`: Antenna Genius port number.
94
89
 
90
+ `Disabled Background (string)`: Background color to use for an antenna that is disabled.
95
91
 
92
+ `Active Background (string)`: Background color to use for an antenna that is active (e.g. can be selected).
96
93
 
94
+ `Selected Background (string)`: Background color to use for and antenna that is selected.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "node-red-contrib-antenna-genius",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Antenna Genius Control and Monitoring Nodes",
5
5
  "scripts": {
6
6
  "test": "mocha \"test/**/*_spec.js\"",