From 1a4ba6a7d30f79128ce4cdee1ef5702c25c3fca7 Mon Sep 17 00:00:00 2001 From: Brendan Le Foll Date: Thu, 21 Sep 2017 13:38:06 +0200 Subject: [PATCH] docs: Update various references and texts Signed-off-by: Brendan Le Foll --- COPYING | 2 +- README.md | 2 +- docs/debugging.md | 13 +++++++++---- docs/index.md | 5 +++++ docs/internals.md | 4 ++++ 5 files changed, 20 insertions(+), 6 deletions(-) diff --git a/COPYING b/COPYING index 8122e43d8..381ca740a 100644 --- a/COPYING +++ b/COPYING @@ -1,5 +1,5 @@ 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 a copy of this software and associated documentation files (the diff --git a/README.md b/README.md index 9a26a78e3..6f0dc5ba8 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ sudo zypper in mraa 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 C++ compiler and the node development headers, however it's not required to diff --git a/docs/debugging.md b/docs/debugging.md index 26f5b2ebd..dee4a99e7 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -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. 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 -built out of tree (see our building doc) - or you don't have git installed. +you built from git then please tell us which commit hash you used. Mraa no +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 @@ -22,10 +25,12 @@ systemd likely your log is in /var/log/messages or a similar location. ### 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 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 platform documentation diff --git a/docs/index.md b/docs/index.md index 443c1940d..d832cfb99 100644 --- a/docs/index.md +++ b/docs/index.md @@ -51,6 +51,11 @@ Specific platform information for supported platforms is documented here: - @ref up2 - @ref joule - @ref ft4222 +- @ref _96boards +- @ref de10-nano +- @ref firmata +- @ref grovepi +- @ref mock ## DEBUGGING diff --git a/docs/internals.md b/docs/internals.md index a825375bd..4e23294b0 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -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, 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 ### mraa is published on NPM, there is a target to prebuild a mraa src tarball that