Skip to content

Commit a60a341

Browse files
author
Dave Conway-Jones
committed
Tidy Beaglebone Docs again.
1 parent ca9676b commit a60a341

1 file changed

Lines changed: 24 additions & 24 deletions

File tree

docs/hardware/beagleboneblack.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,53 @@ layout: default
33
title: Running on BeagleBone Boards
44
---
55

6-
We recommend using the latest SD card images based on Debian Stretch - from https://beagleboard.org/latest-images
6+
We recommend using the latest Debian 9 Stretch based SD card images - from
7+
<a href="https://beagleboard.org/latest-images" target="_new">beagleboard.org</a>.
78

89
The 4GB images for BeagleBone boards already have Node-RED pre-installed and set to auto-start, so you can just boot
910
and point your browser at your BeagleBone, port 1880.
1011

1112
To view the Node-RED log
1213

13-
sudo journalctl -f -u node-red -o cat
14+
sudo journalctl -f -u node-red -o cat
1415

1516
To stop Node-RED
1617

17-
sudo service node-red stop
18+
sudo service node-red stop
1819

1920
To start Node-RED
2021

21-
sudo service node-red start
22+
sudo service node-red start
2223

2324

24-
The 2GB console version suitable for flashing to older eMMC versions of the BBB will need to be installed as per below.
25+
The 2GB console version suitable for flashing to older eMMC versions of the BBB will need to be manually installed as per below.
2526

2627
---
2728

2829
#### Upgrading
2930

3031
The latest Debian images already have Node-RED and Node.js installed - the easiest way to upgrade is to use the built in upgrade tool:
3132

32-
sudo apt update
33-
sudo apt upgrade nodejs bb-node-red-installer
33+
sudo apt update
34+
sudo apt upgrade nodejs bb-node-red-installer
3435

3536
This should also restart the Node-RED service - but you will need to refresh any open browser sessions.
3637

37-
If you are on the 2017 Debian 9.2 version you may need to run `sudo apt dist-upgrade` first.
38+
If you are on the 2017 Debian 9.2 version you may need to run `sudo apt full-upgrade` first.
3839

3940
**Note**: Do NOT use the Raspberry Pi / Debian upgrade script (`update-nodejs-and-nodered`) as it will re-install
4041
both Node.js and Node-RED in different locations and will conflict with and break the existing systemd configuration files.
4142

4243
---
4344

44-
#### Before you start
45+
### Manual installation
4546

4647
<div class="doc-callout">
4748
This section is deprecated in favour of using the images with Node-RED built in. See above.
4849
</div>
4950

51+
#### Before you start
52+
5053
If you are using the 2GB eMMC version of Debian it has been stripped right down so you may need to install some
5154
utility functions first
5255

@@ -68,7 +71,7 @@ We recommend using Node.js LTS 6.x or 8.x
6871
sudo apt-get install -y build-essential nodejs
6972
hash -r
7073

71-
### Installing Node-RED
74+
#### Installing Node-RED
7275

7376
The easiest way to install Node-RED is to use node's package manager, npm:
7477

@@ -82,30 +85,27 @@ this flag avoids this - or rather, shows up any real errors instead.
8285

8386
For other install options, e.g. to run in development mode from GitHub, see the [main installation instructions](../getting-started/installation#install-node-red).
8487

85-
#### BBB specific nodes
88+
#### Beaglebone specific nodes
8689

87-
There are some BBB specific nodes that give you direct access to the I/O pins in the simplest possible manner.
90+
There are some Beaglebone specific nodes that give you direct access to the I/O pins in the simplest possible manner.
8891
The easiest way to install them is direct from npm.
8992

90-
For Debian based builds with kernel 4.x run the following commands in the user
91-
directory of your Node-RED install. This is usually `~/.node-red`
93+
To install manually run the following command:
9294

9395
sudo npm install -g --unsafe-perm beaglebone-io johnny-five node-red-contrib-gpio
9496

97+
*Note*: There is also a set of BBB specific nodes that can be used. However they are built on a no longer supported
98+
library (octalbonescript), and so are not recommended for future use, but are noted for having some extra capabilities
99+
beyond the generic gpio nodes.
95100

96-
### Starting Node-RED
97-
98-
Due to the constrained memory available on the BBB, it is advisable to
99-
run Node-RED with the `node-red-pi` command. For details and other options such
100-
as auto-starting on boot, follow the [Running Node-RED](../getting-started/running)
101-
instructions.
101+
sudo npm install -g --unsafe-perm node-red-node-beaglebone
102102

103-
To access the GPIO pins it is currently necessary to run as root :
103+
### Starting Node-RED
104104

105-
sudo node-red-pi
105+
Due to the constrained memory available on the Beaglebone boards, it is advisable to
106+
run Node-RED with the command:
106107

107-
There are ways to avoid this using udev rules and groups and so on - but that is
108-
beyond the scope of this readme. Google is your friend.
108+
node-red-pi
109109

110110
#### Auto-starting
111111

0 commit comments

Comments
 (0)