aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2018-07-26Fixed small things on grove and web-socket and redid webusb, which I (#1895)t-harvey
somehow missed on the first go around. Signed-off-by: Timothy Harvey <t-harvey@ti.com>
2018-07-13[docs] Update WebIDL and modify docs to fit new "node.js-like" style, Part 2 ↵t-harvey
(#1893) Reinserted WebIDL for buffer.md; changed the WebIDL in aio and ble to be syntactically correct and to follow the new style of buffer.md. Added a new file that explains some of the differences between WebIDL and Javascript. Signed-off-by: Timothy Harvey <t-harvey@ti.com>
2018-04-16[ashell] Minor doc tweaks (#1867)Brian Jones
Signed-off-by: Brian J Jones <brian.j.jones@intel.com>
2018-03-06[sensor] Implements new W3C Generic Sensor API (#1837)Jimmy Huang
In the latest W3C spec, onchange event handler has been renamed to onreading, and the state property is no longer exposed in the sensor object. Fixes #1829 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2018-02-07Update ocf server in 6lowpan-ble.md (#1820)xiaoyu3x
Signed-off-by: Zhang xiaoyu<xiaoyux.zhang@intel.com>
2018-02-01[docs] Updating ASHELL docs with note about default VID/PIDSudarsana Nagineni
Signed-off-by: Sudarsana Nagineni <sudarsana.nagineni@intel.com>
2018-01-19[docs] Add doc on tested board summary info, update readme (#1775)Geoff Gustafson
New doc page compares basic stats about the boards we've tested on. Also, update README to point to this doc page and shrink module support table size. Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2018-01-12[docs] Update github links that have migrated from 01org to intelGeoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2018-01-11[docs] Add documentation of copy and write(string) to buffer.mdGeoff Gustafson
Also, update doc format to be more like Node.js docs instead of WebIDL. Fixes #1618 Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2018-01-08[docs] Add documentation for basic board support (#1728)Geoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2018-01-05[docs] Update ashell.md to fix 1732Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-12-15[docs] Add board support documentation for A101 and K64FGeoff Gustafson
Removed the documentation for old arduino101_pins and k64f_pins modules. Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-11-15[ocf] Updated OCF 6lowpan (#1620)Jimmy Huang
Updated iotivity-constrained with latest 6lowpan fixes, and updated 6lowpan configs to work with latest Zephyr 1.9 Fixes #1586, #1565, #1481, #1237 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-11-10[pwm] Use Board API to identify PWM pinsGeoff Gustafson
Mostly update to match Zoltan's PWM API at: https://github.com/01org/iot-js-api Update all samples and tests using GPIO to the new interface. Update pwm.md documentation. Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-11-09[net] Jerry module fix for net (#1643)Brian Jones
Jerry modules don't support '-' in the name. Renaming net-config to net_config. Signed-off-by: Brian J Jones <brian.j.jones@intel.com>
2017-11-02[docs] Update gfx.md for bug fix (#1628)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-10-31[math] Added MathStubs module with random() api (#1604)Jimmy Huang
Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-10-31[gfx] Initial commit of the GFX module (#1557)Brian Jones
This module is a generic graphics module that can be used by any screen to draw simple shapes and text. I also updated the ST7735 module to use it, as well as the SPI_Screen.js exmaple. Signed-off-by: Brian J Jones <brian.j.jones@intel.com>
2017-10-19[webusb] Add UART support and data APIs to WebUSBGeoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-10-19[buffer] Add utf8 encoding for toString (default as in Node) (#1590)Geoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-10-11[webusb] Add new WebUSB module to support URL advertising (#1568)Geoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-10-11[docs] Updating ASHELL docs with note about SPI pins (#1559)Brian Jones
Pins 10-13 can only be used as SPI on ashell when using the A101. Fixes #727 Signed-off-by: Brian J Jones <brian.j.jones@intel.com>
2017-09-18[webusb] Remove support for the allowed origins request (#1538)Sudarsana Nagineni
Allowed origins header (GET_ALLOWED_ORIGINS) request has been removed from the WebUSB specification, so removing the support for the request. Signed-off-by: Sudarsana Nagineni <sudarsana.nagineni@intel.com>
2017-08-25[ble] Fixed not able to set BLE address (#1484)Jimmy Huang
The bug is that once bt_enable() is called, it's impossible to set the BLE address, so we have to move bt_enable() to be called after all modules and the JS is loaded, this guarantees that any API call to setBleAddress will be called before bt_enable(). Also update documentation to reflect this change. Fixes #1400 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-08-25[ashell] Added command to erase flash file system (#1477)Jimmy Huang
Added ability to erase the flash in Ashell/IDE, this will help fix corrupted files created on the file system. Fixes #1193 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-08-23[spi] Fix incorrect spi speed bus set (#1449)Jimmy Huang
The SPI interface in Zephyr seems to accept a different input for the max_sys_freq when configuring the bus, on the Arduino 101, it is expecting it to be the clock divider and on the FRDM-K64F, it is expecting it to be the baud rate. Also removes configs that are not needed as it is automatically set by Zephyr when you turn on SPI. Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-08-16[docs] Remove mention of non-functional BLE RSSI APIGeoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-08-16[docs] Move to a common Node.js-like format for documenting eventsGeoff Gustafson
Fixes #1403 Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-08-15[docs] Update ashell docs to match current command set (#1472)Geoff Gustafson
Update the help display to match and add documentation for various commands that weren't documented. Also, remove mention of ihex transfer because we plan to eventually remove it entirely, and it's not really useful to the user in ashell mode. Fixes #1195 Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-08-15[fs] Fixed invalid FSstat object when file is deleted (#1464)Jimmy Huang
We are not currently checking if the file exists when calling FS.statSync() to create the Stats object, in which case if the file doesn't exists, we should return a undefined value, and the unit tests should also check if the value is undefined. Added a ToDo to properly fix this with adding a FS.exist() api that can be used to check if the file exists, and then return a valid FSStat object when the file is invalid according the NodeJS spec. Also updated tests and API doc to reflect new change. Fixes #1205 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-08-10[net-config] Update docs to require setting IP address (#1448)Geoff Gustafson
If the net-config module is included, the user needs to either set a static IP address or use DHCP; no default address will be set. We could potentially change this, but this requirement makes for better example code because it's more realistic. Added setStaticIP call to a sample and a test that needed it. Fixes #1413 Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-08-09[docs] Update ble.md to fix link and add parameter for setServices() (#1438)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-08-03[docs] Update buffer.md for link fix (#1429)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-07-31[buffer] Add fill API (#1414)Geoff Gustafson
Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-07-25[tests] Update uart tests and doc for promise removed (#1347)Hao Li
- Update uart tests to remove promise. - Remove promise in uart doc because write return void now. Signed-off-by: Li, Hao <hao.x.li@intel.com>
2017-07-24[docs] Removed onup event from net, now in net-config (#1388)James Prestwood
Fixes #1371 Signed-off-by: James Prestwood <james.prestwood@intel.com>
2017-07-24[ocf] Fix OCF Server Request API (#1382)Jimmy Huang
Update API of OCF Server Request and all the samples so they are in sync with API doc. Also fixes some typos in the tests. Fixes #1334 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-07-24[pme] Drop neuron context APIs as it's internal-only (#1376)Jimmy Huang
The setNeuronContext() and getNeuronContext() APIs are internal APIs that should only be called in save/restore modes, applications should not be calling this function directly, but instead use the saveNeurons() and restoreNeurons() instead. Also dropping setGlobalContext() which is internal as well. Fixes #1245, #1246 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-07-14[docs] Fix typo in net-config.md (#1339)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-07-10[docs] Added docs for net-config moduleJames Prestwood
Signed-off-by: James Prestwood <james.prestwood@intel.com>
2017-06-29[doc] Fix typo in PME doc (#1321)Jimmy Huang
The number of committed neurons can be 0-128, also fixed parameter type to be consistent. Fixes #1244, #1249 Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-06-22[pme] Update PME doc for adding save and restore APIs (#1302)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-06-20[spi] Add docs for SPI along with a NULL check (#1274)Brian Jones
Signed-off-by: Brian Jones <brian.j.jones@intel.com>
2017-06-15[webusb] Define device interface GUID (#1240)Sudarsana Nagineni
This defines device interface GUID in the extended properties descriptor so that the Windows generic driver WinUSB will be loaded automatically when the device is connected to the host. This makes the installation process simple on Windows. Also, we do not need to install the driver manually anymore, so removing Zadig utility instructions from the docs. Signed-off-by: Sudarsana Nagineni <sudarsana.nagineni@intel.com>
2017-06-15[pme] Add save and restore functionality (#1143)Jimmy Huang
Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-06-08[docs] Remove reference to openAsync in gpio docs (#1220)Geoff Gustafson
Fixes #1130. Signed-off-by: Geoff Gustafson <geoff@linux.intel.com>
2017-06-01[net] Update the type of 'family' attribute to same as sample (#1207)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-05-24[pme] Fix PME sample url for pme.md doc (#1200)Cui Yan
Signed-off-by: Cui Yan <yanx.cui@intel.com>
2017-05-18[doc] Update Ashell/IDE instructions (#1170)Jimmy Huang
Signed-off-by: Jimmy Huang <jimmy.huang@intel.com>
2017-05-16[ashell] Add missing instruction for windows setupSudarsana Nagineni
Following previous commit, add missing instruction for windows setup. Signed-off-by: Sudarsana Nagineni <sudarsana.nagineni@intel.com>