Added new getting started guide for node js by liam-b · Pull Request #357 · ev3dev/ev3dev.github.io

liam-b · 2017-03-24T23:07:41Z

No description provided.

WasabiFan · 2017-03-25T00:25:49Z

~~Sorry about the Travis CI server error; it's currently having some issues. Your page doesn't have any errors.~~ I convinced it to be less angry. The status is green!

WasabiFan

Thanks for writing this up! It looks great; I added a fair number of nit-picking comments because I'm a perfectionist 😉

Can you update the description here to include "getting started guides" for this catagory?

WasabiFan · 2017-03-25T00:02:28Z

docs/tutorials/getting-started-with-node-js.md

+---
+
+{% include /style/icon.html type="warning" %}
+Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.


run -> runs

WasabiFan · 2017-03-25T00:03:07Z

docs/tutorials/getting-started-with-node-js.md

+---
+
+{% include /style/icon.html type="warning" %}
+Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.


"really" sounds mildly unprofessional in this context. Can we use another word there?

WasabiFan · 2017-03-25T00:03:15Z

docs/tutorials/getting-started-with-node-js.md

+---
+
+{% include /style/icon.html type="warning" %}
+Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.


NPM is npm

WasabiFan · 2017-03-25T00:04:05Z

docs/tutorials/getting-started-with-node-js.md

+---
+
+{% include /style/icon.html type="warning" %}
+Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.


It's also limited to an equivalently old Node.js version, which should also be mentioned.

WasabiFan · 2017-03-25T00:04:35Z

docs/tutorials/getting-started-with-node-js.md

+Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.
+{: .alert .alert-warning}
+
+**Before you start, make sure that you have configured a network connection to


Can you link to the tutorials that we have for these tasks?

WasabiFan · 2017-03-25T00:22:20Z

docs/tutorials/getting-started-with-node-js.md

+sensor.mode = 'NEW-MODE'; // where 'NEW-MODE' can be replaced by any valid mode
+```
+
+And then using `sensor.someValueAcessor` will return the sensor value, where `someValueAcessor` can be replaced by any valid accessor (also found on the [default supported sensors](http://wasabifan.github.io/ev3dev-lang-js/modules/_sensors_.html) list by clicking on the sensor you are using)


accessor (two Cs)

WasabiFan · 2017-03-25T00:22:38Z

docs/tutorials/getting-started-with-node-js.md

+And then using `sensor.someValueAcessor` will return the sensor value, where `someValueAcessor` can be replaced by any valid accessor (also found on the [default supported sensors](http://wasabifan.github.io/ev3dev-lang-js/modules/_sensors_.html) list by clicking on the sensor you are using)
+
+## Next steps
+So that's the basic overview of how to use node with ev3dev! For info on all supported sensors, motors and other documentation visit the [github page](https://github.com/wasabifan/ev3dev-lang-js) and the [documentation page](http://wasabifan.github.io/ev3dev-lang-js).


Remove "So"

WasabiFan · 2017-03-25T00:24:13Z

docs/tutorials/getting-started-with-node-js.md

+## Next steps
+So that's the basic overview of how to use node with ev3dev! For info on all supported sensors, motors and other documentation visit the [github page](https://github.com/wasabifan/ev3dev-lang-js) and the [documentation page](http://wasabifan.github.io/ev3dev-lang-js).
+
+The documentation page looks a bit confusing, but what you really need to worry about are the names of the classes and the **methods** / **accessors**. (eg. the large motor has **methods** such as: `runForever()`, `runForTime()` etc and the color sensor has **accessors** such as: `reflectedLightIntensity`, `ambientLightIntensity` etc)


ambientLightIntensity etc

should be

ambientLightIntensity, etc.

WasabiFan · 2017-03-25T00:24:32Z

docs/tutorials/getting-started-with-node-js.md

+
+The documentation page looks a bit confusing, but what you really need to worry about are the names of the classes and the **methods** / **accessors**. (eg. the large motor has **methods** such as: `runForever()`, `runForTime()` etc and the color sensor has **accessors** such as: `reflectedLightIntensity`, `ambientLightIntensity` etc)
+
+The [sensor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/sensor_data.html) and the [motor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/motor_data.html) are both really useful pages aswell.


really -> extremely

WasabiFan · 2017-03-25T00:24:40Z

docs/tutorials/getting-started-with-node-js.md

+
+The documentation page looks a bit confusing, but what you really need to worry about are the names of the classes and the **methods** / **accessors**. (eg. the large motor has **methods** such as: `runForever()`, `runForTime()` etc and the color sensor has **accessors** such as: `reflectedLightIntensity`, `ambientLightIntensity` etc)
+
+The [sensor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/sensor_data.html) and the [motor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/motor_data.html) are both really useful pages aswell.


aswell -> as well

liam-b · 2017-03-25T07:15:07Z

Hey! Yeah, I'm not the greatest at writing documentation :). Thanks for editing it though! I added 'getting started guides' to the description of that category and went through and fixed what you pointed out (I haven't committed some things yet).

Just a quick question, what other versions are npm limited to? Because it's 0.10.29 on my brick.

Thanks,
Liam

WasabiFan · 2017-03-25T07:33:49Z

Yeah, I'm not the greatest at writing documentation :).

No problem! It's always easier to spot issues as a reviewer than as the original author... You grow blind out of familiarity.

Just a quick question, what other versions are npm limited to? Because it's 0.10.29 on my brick.

npm may be at that version -- I've never actually checked; my comment was that Node.js itself is stuck on 0.10 or 0.12 (I can't remember exactly) and support has essentially been dropped for the EV3's processor since. When you said "npm" did you mean "node"?

WasabiFan · 2017-03-27T06:09:25Z

I added my suggested changes to this PR; @liam-b if you disagree with any of them, feel free to edit it back or ask!

@dlech can you take a quick pass over this?

dlech · 2017-03-27T16:33:09Z

docs/tutorials/getting-started-with-node-js.md


 {% include /style/icon.html type="warning" %}
-Note that Node JS run really slowly on the EV3 brick and is limited to NPM version 0.10.29 which can be a problem when trying to install some libraries.
+Note that Node.js runs frustratingly slowly on the EV3 brick and is limited to an old version of both Node.js and npm. You may want to consider using Python or another ev3dev-supported language instead.


It looks like non-EV3 stretch images are going to have node 4.7.2

dlech · 2017-03-27T16:35:18Z

_data/tutorial-groups.yml

  - id: software-languages
    title: Programming Languages and Tooling
-    description: "Configuring a development environment, installing new languages, and using advanced language tools."
+    description: "Configuring a development environment, installing new languages, using advanced language tools and getting started guides for languages."


It might be better to put "getting started" first in the list.

dlech · 2017-03-27T16:36:54Z

docs/tutorials/getting-started-with-node-js.md

+
+<p class="lead">
+Node.js is a framework that allows you to run JavaScript as a local application. It is designed to make building servers and other asynchronous apps as easy as possible. In this tutorial, we'll show you how to get up-and-running with Node.js on ev3dev.
+</p>


Just do {: .lead} at the end here. Kramdown automatically creates the paragraph element.

dlech · 2017-03-27T16:38:55Z

docs/tutorials/getting-started-with-node-js.md

+To start, navigate to a project directory (e.g `~/src/js`) that we can store our files in:
+
+```shell
+mkdir -p ~/src/js && cd ~/src/js


This might be better as 2 separate lines instead of &&

dlech · 2017-03-27T16:41:52Z

docs/tutorials/getting-started-with-node-js.md

+```javascript
+var ev3dev = require('ev3dev-lang');
+
+var motor = new ev3dev.Motor('outA'); // create new motor plugged into port A called 'motor'


Might want a link to http://www.ev3dev.org/docs/platform-comparison/ here to get the port names for non-EV3 hardware.

Added new getting started guide for node js

5011bb7

WasabiFan reviewed Mar 25, 2017

View reviewed changes

WasabiFan requested a review from dlech March 25, 2017 00:27

added 'getting started guides' for languages and tooling category

3036fbe

Update getting-started-with-node-js.md

90e988b

dlech reviewed Mar 27, 2017

View reviewed changes

added node and npm versions

4f19dbb

dlech force-pushed the master branch from a126dfd to 536a64c Compare June 14, 2018 18:33


		The documentation page looks a bit confusing, but what you really need to worry about are the names of the classes and the methods / accessors. (eg. the large motor has methods such as: `runForever()`, `runForTime()` etc and the color sensor has accessors such as: `reflectedLightIntensity`, `ambientLightIntensity` etc)

		The [sensor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/sensor_data.html) and the [motor list](http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-jessie/motor_data.html) are both really useful pages aswell.

Conversation

liam-b commented Mar 24, 2017

Uh oh!

WasabiFan commented Mar 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WasabiFan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

liam-b commented Mar 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WasabiFan commented Mar 25, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

WasabiFan commented Mar 27, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WasabiFan commented Mar 25, 2017 •

edited

Loading

liam-b commented Mar 25, 2017 •

edited

Loading

WasabiFan commented Mar 25, 2017 •

edited

Loading