docs: Update various references and texts
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
2
COPYING
2
COPYING
@@ -1,5 +1,5 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
Copyright © 2014-2016 Intel Corporation
|
Copyright © 2014-2018 Intel Corporation
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
a copy of this software and associated documentation files (the
|
a copy of this software and associated documentation files (the
|
||||||
|
|||||||
@@ -99,7 +99,7 @@ sudo zypper in mraa
|
|||||||
Installing for Node.js only
|
Installing for Node.js only
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
> Note: Node.js 7.0.0+ is not supported. You'll have to downgrade to 6.x.x.
|
> Note: Node.js 7.0.0+ is not currntly supported. You'll have to downgrade to 6.x.x.
|
||||||
|
|
||||||
You can also install just the node.js mraa module by using npm. You will need a
|
You can also install just the node.js mraa module by using npm. You will need a
|
||||||
C++ compiler and the node development headers, however it's not required to
|
C++ compiler and the node development headers, however it's not required to
|
||||||
|
|||||||
@@ -8,8 +8,11 @@ this list as it's the first thing we'll ask you to do.
|
|||||||
|
|
||||||
Getting the exact version of libmraa you're running is really important to us.
|
Getting the exact version of libmraa you're running is really important to us.
|
||||||
The best way to get this is to call mraa_get_version() or mraa.getVersion(). If
|
The best way to get this is to call mraa_get_version() or mraa.getVersion(). If
|
||||||
mraa returns x.x.x-dirty then your version was not built from a git tree or you
|
you built from git then please tell us which commit hash you used. Mraa no
|
||||||
built out of tree (see our building doc) - or you don't have git installed.
|
longer tags itself as 'dirty' if built as a non tagged version but simply uses
|
||||||
|
the latest version number listed in the top level CMakeLists.txt file. Note
|
||||||
|
that you may have to wipe the build/ dir for git sha version to be absolutely
|
||||||
|
correct.
|
||||||
|
|
||||||
### Finding error logs
|
### Finding error logs
|
||||||
|
|
||||||
@@ -22,10 +25,12 @@ systemd likely your log is in /var/log/messages or a similar location.
|
|||||||
|
|
||||||
### Common errors to check for
|
### Common errors to check for
|
||||||
|
|
||||||
* Not running as root
|
* Not running as a user with permissions to the physical char devices/files
|
||||||
|
that require access. Check quickly if it works as root and you likely have
|
||||||
|
such an issue. The log file will reflect this
|
||||||
* Incorrect IO pin numbers, mraa uses physical connector pin numbering see your
|
* Incorrect IO pin numbers, mraa uses physical connector pin numbering see your
|
||||||
platform documentation for details
|
platform documentation for details
|
||||||
* Your platform is unsupported
|
* Your platform is unsupported or has been detected wrongly (logfile will show this)
|
||||||
* Using the wrong pin, check pin capabilities either using the API or your
|
* Using the wrong pin, check pin capabilities either using the API or your
|
||||||
platform documentation
|
platform documentation
|
||||||
|
|
||||||
|
|||||||
@@ -51,6 +51,11 @@ Specific platform information for supported platforms is documented here:
|
|||||||
- @ref up2
|
- @ref up2
|
||||||
- @ref joule
|
- @ref joule
|
||||||
- @ref ft4222
|
- @ref ft4222
|
||||||
|
- @ref _96boards
|
||||||
|
- @ref de10-nano
|
||||||
|
- @ref firmata
|
||||||
|
- @ref grovepi
|
||||||
|
- @ref mock
|
||||||
|
|
||||||
## DEBUGGING
|
## DEBUGGING
|
||||||
|
|
||||||
|
|||||||
@@ -166,6 +166,10 @@ conversions and memory allocations are performed so the performance of using
|
|||||||
these functions compared to the C/C++ equivalent will likely be a little lower,
|
these functions compared to the C/C++ equivalent will likely be a little lower,
|
||||||
however it is much more natural than using carrays.i typemap library.
|
however it is much more natural than using carrays.i typemap library.
|
||||||
|
|
||||||
|
Note that node v7.x.x is not yet supported in SWIG, however this is a patchset
|
||||||
|
in SWIG that enables this and does enable mraa to compile and work against a
|
||||||
|
newer nodejs version.
|
||||||
|
|
||||||
### NPM ###
|
### NPM ###
|
||||||
|
|
||||||
mraa is published on NPM, there is a target to prebuild a mraa src tarball that
|
mraa is published on NPM, there is a target to prebuild a mraa src tarball that
|
||||||
|
|||||||
Reference in New Issue
Block a user