You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 20, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,8 +73,8 @@ node -v
73
73
```
74
74
Check the latest version of NVM before you install (it might be higher than v0.35.3). You can go online to learn how to use NVM to switch node versions on the fly.
75
75
76
-
##### Using sudo
77
-
It is important to note that because our scripts use the Bluetooth libraries of the OS, it is required to use sudo (or you will get a warning and the scripts won't work). You need to decide if you are ok to use sudo or not.
76
+
##### Using sudo - a Warning
77
+
It is important to note that because our scripts use OS level Bluetooth libraries, it may be required to use sudo (or you will get a warning and the scripts won't work). You need to decide if you are ok to use sudo or not.
78
78
79
79
You also need to check that the version of node you are using is as expected for sudo:
80
80
```
@@ -83,7 +83,7 @@ v0.10.23
83
83
$ sudo node -v
84
84
v0.11.8-pre
85
85
```
86
-
As you can see here, the sudo node version is not the same as the current user version. Here's a [workaround](https://stackoverflow.com/questions/21215059/cant-use-nvm-from-root-or-sudo).
86
+
As you can see here, the sudo node version is not the same as the current user version. Here's a [workaround](https://stackoverflow.com/questions/21215059/cant-use-nvm-from-root-or-sudo). You can google-fu more about this topic.
87
87
88
88
### Installation
89
89
@@ -92,16 +92,16 @@ You have two options for installation:
92
92
#### 1. Use NPM
93
93
The Mbient JavaScript SDK relies on [Noble](https://github.com/mbientlab/noble) and [Noble-Device](https://github.com/mbientlab/noble-device) for Bluetooth Low Energy communications.
94
94
95
-
You need to setup the relevant [prerequisites for Noble](https://github.com/mbientlab/noble#prerequisites) and then [install Noble](https://github.com/mbientlab/noble#install).
96
-
97
-
Make sure you use our versions of these libraries as the original packages have been abandoned.
95
+
You need to setup the relevant [prerequisites for Noble](https://github.com/mbientlab/noble#prerequisites) and then [install Noble](https://github.com/mbientlab/noble#install). Make sure you use our versions of these libraries as the original packages have been abandoned.
98
96
99
97
Then you can simply install the MetaWear package lib with NPM using the command line:
100
-
```javascript
98
+
```
101
99
npm install metawear
102
-
npm update metawear
103
100
```
104
101
This step takes a long time as all the packages are installed and the MetaWear CPP library will be compiled on your machine. You may or may not need to update.
102
+
```
103
+
npm update metawear
104
+
```
105
105
106
106
#### 2. Use our Repository
107
107
We packaged everything for you already in this repository with the package.json file ready to be installed with npm.
@@ -132,11 +132,13 @@ Please note that the examples in our examples folder will use the local metawear
132
132
```javascript
133
133
var MetaWear =require('../index')
134
134
```
135
+
This would be using the local metawear code. You will probably never need this unless you are planning to change our internal libraries.
135
136
136
137
Simply change it to this:
137
138
```javascript
138
139
var MetaWear =require('metawear');
139
140
```
141
+
This would be using the metawear code in your local npm `node_modules` directory as installed. This is the prefered way.
140
142
141
143
#### Notes
142
144
You should familiarize yourself with this README and our tutorials since there a few limitiations and other gotchas spelled out, such as the maximum number of simultaneous Bluetooth connections.
0 commit comments