hueget 0.6.5 → 0.6.6

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.
package/CHANGELOG.md CHANGED
@@ -4,6 +4,9 @@ See the [Readme file](https://github.com/jsiegenthaler/hueget/blob/master/README
4
4
 
5
5
  # Bug Fixes and Improvements
6
6
 
7
+ ## 0.6.6 (2023-11-27)
8
+ * Added some more README.md improvements
9
+
7
10
  ## 0.6.5 (2023-11-27)
8
11
  * Added error handling to catch listener errors (e.g. port in use)
9
12
  * Added some more README.md improvements
package/README.md CHANGED
@@ -35,19 +35,20 @@ Flash lights in a room or in any group (zone, room) when someone comes home. The
35
35
  # Installing hueget
36
36
  I run hueget on my raspberry pi. To install the latest version with NPM:
37
37
  ```
38
- $ sudo npm install -g hueget
38
+ $ npm install hueget
39
39
  ```
40
40
  Or for the latest beta version:
41
41
  ```
42
- $ sudo npm install -g hueget@beta
42
+ $ npm install hueget@beta
43
43
  ```
44
44
 
45
- npm installs hueget in `/usr/local/lib/node_modules/hueget/`.
45
+ You need to know where hueget was installed. Use `find -name hueget.js` to find the location of hueget.
46
+ I prefer to install locally. In my case, on my Raspberry Pi and using the default user pi, hueget installs in `/home/pi/node_modules/hueget/`
46
47
 
47
48
  # Updating hueget
48
49
  To update hueget to the latest version:
49
50
  ```
50
- $ sudo npm update -g hueget
51
+ $ npm update hueget
51
52
  ```
52
53
 
53
54
 
@@ -56,11 +57,12 @@ The following examples assume you have hueget in a folder that your system can f
56
57
 
57
58
  To see the help text, start hueget without any arguments as follows:
58
59
  ```
59
- $ node /usr/local/lib/node_modules/hueget/hueget.js
60
+ $ node /home/pi/node_modules/hueget/hueget.js
60
61
  ```
61
62
 
62
63
  hueget shows the following response:
63
64
  ```
65
+ Missing option: "--ip"
64
66
  USAGE: node hueget.js [OPTION1] [OPTION2]... arg1 arg2...
65
67
  The following options are supported:
66
68
  -i, --ip <ARG1> Philips Hue bridge IP address (required)
@@ -71,11 +73,11 @@ Note that options can be entered in any order.
71
73
 
72
74
  Example to run hueget on a raspberry pi to connect to a Philips Hue bridge with ip address `192.168.0.101`, default port `3000`, and with a Hue username of `UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj`:
73
75
  ```
74
- $ node /usr/local/lib/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
76
+ $ node /home/pi/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj
75
77
  ```
76
78
  The same again, but using port `1234`:
77
79
  ```
78
- $ node /usr/local/lib/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 1234
80
+ $ node /home/pi/node_modules/hueget/hueget.js -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 1234
79
81
  ```
80
82
  A successful start of hueget (using the above command to specify ip address 192.168.0.100 and port 1234) will show:
81
83
  ```
@@ -91,7 +93,7 @@ $ pm2 startup
91
93
 
92
94
  To start hueget with pm2, and have it daemonized, monitored and kept alive forever:
93
95
  ```
94
- $ pm2 start /usr/local/lib/node_modules/hueget/hueget.js -- -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 3000
96
+ $ pm2 start /home/pi/node_modules/hueget/hueget.js -- -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 3000
95
97
  ```
96
98
  Check that hueget has started:
97
99
  ```
@@ -105,7 +107,7 @@ $ pm2 save
105
107
  Managing hueget in pm2 is straightforward:
106
108
  ```
107
109
  $ pm2 status
108
- $ pm2 start /usr/local/lib/node_modules/hueget/hueget.js -- -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 3000
110
+ $ pm2 start /home/pi/node_modules/hueget/hueget.js.js -- -i 192.168.0.101 -u UBxWZChHseyjeFwAkwgbdQ08x9XASWpanZZVg-mj -p 3000
109
111
  $ pm2 save
110
112
  $ pm2 stop hueget
111
113
  $ pm2 restart hueget
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hueget",
3
- "version": "0.6.5",
3
+ "version": "0.6.6",
4
4
  "description": "A simple API that converts the Philips Hue API PUT to GET requests, allowing control of Philips Hue lights via http GET requests",
5
5
  "main": "hueget.js",
6
6
  "scripts": {