Add os download wifi example

balena-io · Dec 2, 2015 · a0cdd64 · a0cdd64
1 parent 6b34982
commit a0cdd64
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 0 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -1347,22 +1347,40 @@ resin.models.environmentVariables.isSystemVariable({
 
 **Example**  
 ```js
+// Ethernet
 var parameters = {
 	network: 'ethernet',
 	appId: 91
 };
 
+// Wifi
+var parameters = {
+	network: 'wifi',
+	wifiSsid: 'ssid',
+	wifiKey: 'secret',
+	appId: 91
+};
+
 resin.models.os.download(parameters).then(function(stream) {
 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));
 });
 ```
 **Example**  
 ```js
+// Ethernet
 var parameters = {
 	network: 'ethernet',
 	appId: 91
 };
 
+// Wifi
+var parameters = {
+	network: 'wifi',
+	wifiSsid: 'ssid',
+	wifiKey: 'secret',
+	appId: 91
+};
+
 resin.models.os.download(parameters, function(error, stream) {
 	if (error) throw error;
 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));

diff --git a/build/models/os.js b/build/models/os.js
@@ -43,21 +43,39 @@ THE SOFTWARE.
    * @todo In the future this function should only require a device type slug.
    *
    * @example
+   * // Ethernet
    * var parameters = {
    * 	network: 'ethernet',
    * 	appId: 91
    * };
    *
+   * // Wifi
+   * var parameters = {
+   * 	network: 'wifi',
+   * 	wifiSsid: 'ssid',
+   * 	wifiKey: 'secret',
+   * 	appId: 91
+   * };
+   *
    * resin.models.os.download(parameters).then(function(stream) {
    * 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));
    * });
    *
    * @example
+   * // Ethernet
    * var parameters = {
    * 	network: 'ethernet',
    * 	appId: 91
    * };
    *
+   * // Wifi
+   * var parameters = {
+   * 	network: 'wifi',
+   * 	wifiSsid: 'ssid',
+   * 	wifiKey: 'secret',
+   * 	appId: 91
+   * };
+   *
    * resin.models.os.download(parameters, function(error, stream) {
    * 	if (error) throw error;
    * 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));

diff --git a/lib/models/os.coffee b/lib/models/os.coffee
@@ -38,21 +38,39 @@ request = require('resin-request')
 # @todo In the future this function should only require a device type slug.
 #
 # @example
+# // Ethernet
 # var parameters = {
 # 	network: 'ethernet',
 # 	appId: 91
 # };
 #
+# // Wifi
+# var parameters = {
+# 	network: 'wifi',
+# 	wifiSsid: 'ssid',
+# 	wifiKey: 'secret',
+# 	appId: 91
+# };
+#
 # resin.models.os.download(parameters).then(function(stream) {
 # 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));
 # });
 #
 # @example
+# // Ethernet
 # var parameters = {
 # 	network: 'ethernet',
 # 	appId: 91
 # };
 #
+# // Wifi
+# var parameters = {
+# 	network: 'wifi',
+# 	wifiSsid: 'ssid',
+# 	wifiKey: 'secret',
+# 	appId: 91
+# };
+#
 # resin.models.os.download(parameters, function(error, stream) {
 # 	if (error) throw error;
 # 	stream.pipe(fs.createWriteStream('foo/bar/image.img'));