Skip to content

Commit 3b68437

Browse files
author
Dave Conway-Jones
committed
update Pi docs slightly to try to remove ambiguity about apt.
1 parent eb168ea commit 3b68437

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

docs/hardware/raspberrypi.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,27 @@ title: Running on Raspberry Pi
55

66
The recommended way to install Node-RED on Pi is to use our script below, however Node-RED can be installed from the Recommended Software application installed on the Raspbian SD card image that can be downloaded from [RaspberryPi.org](https://www.raspberrypi.org/downloads/raspbian/). If installed in this manner it is recommended to upgrade by using the script below.
77

8-
If you decide not to use the script, and stick with apt to install Node-RED, then you **must** manually install npm and then upgrade it to the latest level by `sudo apt-get install npm && sudo npm i -g npm` before installing any extra nodes.
9-
108
You can upgrade Node-RED by re-running the script.
119

1210
### Install / Upgrade
1311

14-
If you have a version of Raspbian, or other **Debian** based install, such as **Ubuntu**, or **Diet-Pi**, that doesn't have Node-RED
15-
already installed, you can install or upgrade using the Node-RED upgrade script command
12+
If you have a version of Raspbian, or other **Debian** based install, such as **Ubuntu**, or **Diet-Pi**,
13+
that doesn't have Node-RED already installed, you can install or upgrade using the Node-RED upgrade script command
1614

1715
bash <(curl -sL https://raw.githubusercontent.com/node-red/raspbian-deb-package/master/resources/update-nodejs-and-nodered)
1816

19-
On really minimal Debian installs you may want to `sudo apt-get install build-essential` before running the script so that the serialport builds and installs OK. This is optional.
17+
On really minimal Debian installs you may need to run `sudo apt-get install build-essential` before running the script
18+
so that the serialport builds and installs OK. This is optional.
2019

2120
#### Script Description
2221

2322
Nodes can be now be managed via the built in palette manager. However the default Pi install pre-loads some
2423
nodes globally and these cannot then be easily managed and updated. The intention of the script is to...
2524

26-
- upgrade an existing user to LTS 8.x Node.js and latest Node-RED
25+
- upgrade an existing user to LTS 8.x or 10.x Node.js and latest Node-RED
2726
- migrate any existing globally installed nodes into the users ~/.node-red space so they can be managed via the palette manager
2827
- optionally (re)install the extra nodes that are pre-installed on a full Raspbian Pi image
28+
- Note: it DOES NOT update any user installed existing nodes. This must be done manually by the user (see below).
2929

3030
While aimed at the Pi user the script will also run on any Debian based operating system, such as Ubuntu, and so can
3131
be used on other hardware platforms, although it has not been widely tested.
@@ -40,7 +40,7 @@ The script will perform the following steps
4040
- remove any node-red binaries from /usr/bin and /usr/local/bin
4141
- remove any node-red modules from /usr/lib/node_modules and /usr/local/lib/node_modules
4242
- detect if Node.js was installed from Node.js package or Debian
43-
- if not v8 or newer - remove as appropriate and install latest v8 LTS (not using apt).
43+
- if not v8 or newer - remove as appropriate and install latest v8 or v10 LTS (not using apt).
4444
- clean out npm cache and .node-gyp cache to remove any previous versions of code
4545
- install Node-RED latest version
4646
- re-install under the user account any nodes that had previously been installed globally
@@ -100,13 +100,13 @@ If you want Node-RED to run when the Pi boots up you can use
100100
and likewise `sudo systemctl disable nodered.service` to disable autostart on boot.
101101

102102

103-
#### Adding nodes to preloaded version
103+
#### Adding nodes to preloaded Raspbian version
104104

105-
To add additional nodes you must first install the `npm` tool, as it is not included
106-
in the default Raspbian installation. This is not necessary if you have upgraded to Node.js 8.x.
105+
If you **have not upgraded** the pre-installed version to the latest version using the script above, then in
106+
order o add additional nodes you must first install the `npm` tool, as it is not included
107+
in the default Raspbian installation. This is not necessary if you have upgraded using the script above.
107108

108-
The following commands install `npm` and then upgrade
109-
it to the latest version.
109+
The following commands install `npm` and then upgrade it to the latest version.
110110

111111
sudo apt-get install npm
112112
sudo npm install -g npm
@@ -124,7 +124,8 @@ You can then start [using the editor](#using-the-editor).
124124

125125
## Notes
126126

127-
Debian/Raspbian Wheezy is now beyond "End of Life", and is no longer support, and this documentation is now aimed at Jessie as a minimum.
127+
Debian/Raspbian Wheezy is now beyond "End of Life", and is no longer support, and this documentation is now aimed
128+
at Jessie as a minimum.
128129

129130
### Accessing GPIO
130131

@@ -256,13 +257,13 @@ One way to find the IP address of the Pi is to use the command
256257
Then browse to `http://{the-ip-address-returned}:1880/`
257258

258259
<div class="doc-callout">
259-
<em>Note:</em> the default browser included in Raspbian, Epiphany,
260-
has some quirks that mean certain keyboard short-cuts do not work within the
261-
Node-RED editor. We <b>strongly</b> recommend installing the Firefox-ESR browser instead:
260+
<em>Note:</em> the default browser included in Raspbian, used to be Epiphany, and
261+
has some quirks that meant certain keyboard short-cuts do not work within the
262+
Node-RED editor. We <b>strongly</b> recommend installing the Firefox-ESR or Chromium browser instead:
262263
<pre>
263264
sudo apt-get install firefox-esr
264265
</pre>
265-
More recent build include Chromium - which also works fine but can be rather slow on a Pi1 or Zero.
266+
More recent build include Chromium y default - which also works fine but can be rather slow on a Pi1 or Zero.
266267
</div>
267268

268269
You can then start creating your [first flow](../getting-started/first-flow).
@@ -286,6 +287,7 @@ You then need to stop and restart Node-RED to load the new nodes, and then refre
286287
node-red-stop
287288
node-red-start
288289

290+
289291
## Interacting with the Pi hardware
290292

291293
There are several ways of interacting with a Raspberry Pi using Node-RED.

0 commit comments

Comments
 (0)