diff --git a/.gitbook/assets/16-213297_expertise_pycom_wipy-2.0r.pdf b/.gitbook/assets/16-213297_expertise_pycom_wipy-2.0r.pdf new file mode 100644 index 0000000..75aae5c Binary files /dev/null and b/.gitbook/assets/16-213297_expertise_pycom_wipy-2.0r.pdf differ diff --git a/.gitbook/assets/16-213298_expertise_pycom_lopy-1.0r.pdf b/.gitbook/assets/16-213298_expertise_pycom_lopy-1.0r.pdf new file mode 100644 index 0000000..ecc47ac Binary files /dev/null and b/.gitbook/assets/16-213298_expertise_pycom_lopy-1.0r.pdf differ diff --git a/.gitbook/assets/17-210585_expertise_sipy_sipy-1.0.pdf b/.gitbook/assets/17-210585_expertise_sipy_sipy-1.0.pdf new file mode 100644 index 0000000..a598042 Binary files /dev/null and b/.gitbook/assets/17-210585_expertise_sipy_sipy-1.0.pdf differ diff --git a/.gitbook/assets/17-213356_red-certificate_pycom_l01-1.0.pdf b/.gitbook/assets/17-213356_red-certificate_pycom_l01-1.0.pdf new file mode 100644 index 0000000..b1a772b Binary files /dev/null and b/.gitbook/assets/17-213356_red-certificate_pycom_l01-1.0.pdf differ diff --git a/.gitbook/assets/17-213357_red-certificate_pycom_w01-1.0.pdf b/.gitbook/assets/17-213357_red-certificate_pycom_w01-1.0.pdf new file mode 100644 index 0000000..33af03d Binary files /dev/null and b/.gitbook/assets/17-213357_red-certificate_pycom_w01-1.0.pdf differ diff --git a/.gitbook/assets/17-214126_red-certificate_pycom_wipy-3.0.pdf b/.gitbook/assets/17-214126_red-certificate_pycom_wipy-3.0.pdf new file mode 100644 index 0000000..5631811 Binary files /dev/null and b/.gitbook/assets/17-214126_red-certificate_pycom_wipy-3.0.pdf differ diff --git a/.gitbook/assets/172181407_aa_00_final.pdf b/.gitbook/assets/172181407_aa_00_final.pdf new file mode 100644 index 0000000..83414e5 Binary files /dev/null and b/.gitbook/assets/172181407_aa_00_final.pdf differ diff --git a/.gitbook/assets/172181408_aa_00_final.pdf b/.gitbook/assets/172181408_aa_00_final.pdf new file mode 100644 index 0000000..a8cba0f Binary files /dev/null and b/.gitbook/assets/172181408_aa_00_final.pdf differ diff --git a/.gitbook/assets/172181411_aa_00_final.pdf b/.gitbook/assets/172181411_aa_00_final.pdf new file mode 100644 index 0000000..c2f31bb Binary files /dev/null and b/.gitbook/assets/172181411_aa_00_final.pdf differ diff --git a/.gitbook/assets/172181413_aa_00_final.pdf b/.gitbook/assets/172181413_aa_00_final.pdf new file mode 100644 index 0000000..dc1dd89 Binary files /dev/null and b/.gitbook/assets/172181413_aa_00_final.pdf differ diff --git a/.gitbook/assets/172181414_aa_00_final.pdf b/.gitbook/assets/172181414_aa_00_final.pdf new file mode 100644 index 0000000..97fceaa Binary files /dev/null and b/.gitbook/assets/172181414_aa_00_final.pdf differ diff --git a/.gitbook/assets/2090acc16_grant.pdf b/.gitbook/assets/2090acc16_grant.pdf new file mode 100644 index 0000000..a063f36 Binary files /dev/null and b/.gitbook/assets/2090acc16_grant.pdf differ diff --git a/.gitbook/assets/2090bcc16_grant.pdf b/.gitbook/assets/2090bcc16_grant.pdf new file mode 100644 index 0000000..7b9e86e Binary files /dev/null and b/.gitbook/assets/2090bcc16_grant.pdf differ diff --git a/.gitbook/assets/2090ccc16_grant.pdf b/.gitbook/assets/2090ccc16_grant.pdf new file mode 100644 index 0000000..426a11a Binary files /dev/null and b/.gitbook/assets/2090ccc16_grant.pdf differ diff --git a/.gitbook/assets/2091acc16_grant.pdf b/.gitbook/assets/2091acc16_grant.pdf new file mode 100644 index 0000000..c057ae0 Binary files /dev/null and b/.gitbook/assets/2091acc16_grant.pdf differ diff --git a/.gitbook/assets/2091bcc16_grant.pdf b/.gitbook/assets/2091bcc16_grant.pdf new file mode 100644 index 0000000..fffcb62 Binary files /dev/null and b/.gitbook/assets/2091bcc16_grant.pdf differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn7x3eyyjifoqpxmzd-l01-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn7x3eyyjifoqpxmzd-l01-1.png new file mode 100644 index 0000000..4d328bc Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn7x3eyyjifoqpxmzd-l01-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn80ythqnrgah01r2m-lopy-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn80ythqnrgah01r2m-lopy-1.png new file mode 100644 index 0000000..a40db1e Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn80ythqnrgah01r2m-lopy-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82srvkf3rhetvjpi-fipy-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82srvkf3rhetvjpi-fipy-1.png new file mode 100644 index 0000000..ad016d9 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82srvkf3rhetvjpi-fipy-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82uldmpus0lnq1kx-expansion3.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82uldmpus0lnq1kx-expansion3.png new file mode 100644 index 0000000..8dc4600 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn82uldmpus0lnq1kx-expansion3.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ejihh1jeasccad-pytrack.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ejihh1jeasccad-pytrack.png new file mode 100644 index 0000000..b016715 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ejihh1jeasccad-pytrack.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ftusu7mke5ppmd-wipy2-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ftusu7mke5ppmd-wipy2-1.png new file mode 100644 index 0000000..4ad14cf Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83ftusu7mke5ppmd-wipy2-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hclnq-gurt2p_m-pysense.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hclnq-gurt2p_m-pysense.png new file mode 100644 index 0000000..0717dff Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hclnq-gurt2p_m-pysense.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hfia61dsuyojco-pyscan-new.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hfia61dsuyojco-pyscan-new.png new file mode 100644 index 0000000..fb8b5f6 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83hfia61dsuyojco-pyscan-new.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (1).png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (1).png new file mode 100644 index 0000000..c87911b Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (1).png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (2).png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (2).png new file mode 100644 index 0000000..c87911b Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1 (2).png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1.png new file mode 100644 index 0000000..c87911b Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn83xkh3nwgrgs_fwq-g01-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85ios3qzh5brsxk2-w01.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85ios3qzh5brsxk2-w01.png new file mode 100644 index 0000000..1f024bb Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85ios3qzh5brsxk2-w01.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85npgnazxzxyv-nu-lopy4-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85npgnazxzxyv-nu-lopy4-1.png new file mode 100644 index 0000000..c7d3095 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn85npgnazxzxyv-nu-lopy4-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86hknsrea22r0i-s-l04-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86hknsrea22r0i-s-l04-1.png new file mode 100644 index 0000000..89f0030 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86hknsrea22r0i-s-l04-1.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86jsexys_ho7ct7c-expansion2.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86jsexys_ho7ct7c-expansion2.png new file mode 100644 index 0000000..ee10982 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86jsexys_ho7ct7c-expansion2.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86n8h-hb1oh1idwb-sipy-2.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86n8h-hb1oh1idwb-sipy-2.png new file mode 100644 index 0000000..2121341 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86n8h-hb1oh1idwb-sipy-2.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86pdzbdvrponxeg6-wipy3.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86pdzbdvrponxeg6-wipy3.png new file mode 100644 index 0000000..94d1e1a Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn86pdzbdvrponxeg6-wipy3.png differ diff --git a/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn87yf-xz772800vwc-gpy-1.png b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn87yf-xz772800vwc-gpy-1.png new file mode 100644 index 0000000..6163cf6 Binary files /dev/null and b/.gitbook/assets/assets-lil0igdl11z7jos_jpx-lkn7scqkkkb6tqb3uyo-lkn87yf-xz772800vwc-gpy-1.png differ diff --git a/.gitbook/assets/c03-b0-red-final (1).pdf b/.gitbook/assets/c03-b0-red-final (1).pdf new file mode 100644 index 0000000..21445b9 Binary files /dev/null and b/.gitbook/assets/c03-b0-red-final (1).pdf differ diff --git a/.gitbook/assets/c03-b0-red-final.pdf b/.gitbook/assets/c03-b0-red-final.pdf new file mode 100644 index 0000000..a90629d Binary files /dev/null and b/.gitbook/assets/c03-b0-red-final.pdf differ diff --git a/.gitbook/assets/fipy_c03-b0-red-final.pdf b/.gitbook/assets/fipy_c03-b0-red-final.pdf new file mode 100644 index 0000000..bb447df Binary files /dev/null and b/.gitbook/assets/fipy_c03-b0-red-final.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dss.pdf b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dss.pdf new file mode 100644 index 0000000..cc852b6 Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dss.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dts.pdf b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dts.pdf new file mode 100644 index 0000000..d6972da Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dts.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dxx.pdf b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dxx.pdf new file mode 100644 index 0000000..4d0709a Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-dxx.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-tnb.pdf b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-tnb.pdf new file mode 100644 index 0000000..d20570b Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtfipy01r-fcc-grant-tnb.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dss.pdf b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dss.pdf new file mode 100644 index 0000000..74483d4 Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dss.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dts.pdf b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dts.pdf new file mode 100644 index 0000000..2693089 Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-dts.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-tnb.pdf b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-tnb.pdf new file mode 100644 index 0000000..6cd5f01 Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtg01r-fcc-grant-tnb.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dss.pdf b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dss.pdf new file mode 100644 index 0000000..ca0f205 Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dss.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dts.pdf b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dts.pdf new file mode 100644 index 0000000..7dd316f Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-dts.pdf differ diff --git a/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-tnb.pdf b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-tnb.pdf new file mode 100644 index 0000000..266c0fd Binary files /dev/null and b/.gitbook/assets/pycom-2ajmtgpy01r-fcc-grant-tnb.pdf differ diff --git a/.gitbook/assets/pycom.inf b/.gitbook/assets/pycom.inf new file mode 100644 index 0000000..cb00f95 --- /dev/null +++ b/.gitbook/assets/pycom.inf @@ -0,0 +1,71 @@ +; M-Stack CDC-ACM Windows INF file +; +; This file has been tested on Windows 7, 64-bit. It may or may not work on +; Windows versions earlier than 7. Improvements and bug reports are welcome. +; + +[Version] +Signature="$Windows NT$" +Class=Ports +ClassGuid={4D36E978-E325-11CE-BFC1-08002BE10318} +Provider=%MFGNAME% +DriverVer=05/16/2014,1.0.0.18 + +[Manufacturer] +%MFGNAME%=DeviceList, NTx86, NTamd64, NTia64, NTarm + +[DeviceList.NTamd64] +%DESC_CDC_PYSENSE% = DriverInstall, %VID_PID_PYSENSE_STRING% +%DESC_CDC_PYTRACK% = DriverInstall, %VID_PID_PYTRACK_STRING% +%DESC_CDC_PYSCAN% = DriverInstall, %VID_PID_PYSCAN_STRING% +%DESC_CDC_EXPANSION3% = DriverInstall, %VID_PID_EXPANSION3_STRING% + +[DeviceList.NTx86] +%DESC_CDC_PYSENSE% = DriverInstall, %VID_PID_PYSENSE_STRING% +%DESC_CDC_PYTRACK% = DriverInstall, %VID_PID_PYTRACK_STRING% +%DESC_CDC_PYSCAN% = DriverInstall, %VID_PID_PYSCAN_STRING% +%DESC_CDC_EXPANSION3% = DriverInstall, %VID_PID_EXPANSION3_STRING% + +[DeviceList.NTia64] +%DESC_CDC_PYSENSE% = DriverInstall, %VID_PID_PYSENSE_STRING% +%DESC_CDC_PYTRACK% = DriverInstall, %VID_PID_PYTRACK_STRING% +%DESC_CDC_PYSCAN% = DriverInstall, %VID_PID_PYSCAN_STRING% +%DESC_CDC_EXPANSION3% = DriverInstall, %VID_PID_EXPANSION3_STRING% + +[DeviceList.NTarm] +%DESC_CDC_PYSENSE% = DriverInstall, %VID_PID_PYSENSE_STRING% +%DESC_CDC_PYTRACK% = DriverInstall, %VID_PID_PYTRACK_STRING% +%DESC_CDC_PYSCAN% = DriverInstall, %VID_PID_PYSCAN_STRING% +%DESC_CDC_EXPANSION3% = DriverInstall, %VID_PID_EXPANSION3_STRING% + +; For the DriverInstall sections below see: +; http://support.microsoft.com/kb/837637 +; http://www.microchip.com/forums/m488342.aspx +; +; This INF file includes mdmcpq.inf, which is a standard Windows +; INF file that you can find by searching for it recursively from +; %WINDIR%. It's in the WinSxS folders. In that file, you can see +; the symbols referenced here (eg: FakeModemCopyFileSection, etc). + +[DriverInstall.NT] +include=mdmcpq.inf +CopyFiles=FakeModemCopyFileSection + +[DriverInstall.NT.Services] +include=mdmcpq.inf +AddService=usbser, 0x00000002, LowerFilter_Service_Inst + +[DriverInstall.HW] +include=mdmcpq.inf +AddReg=LowerFilterAddReg + +[Strings] +MFGNAME = "Pycom Ltd" +DESC_CDC_PYSENSE = "Pysense" +DESC_CDC_PYTRACK = "Pytrack" +DESC_CDC_PYSCAN = "Pyscan" +DESC_CDC_EXPANSION3 = "Expansion3" +VID_PID_PYSENSE_STRING = "USB\VID_04D8&PID_F012" +VID_PID_PYTRACK_STRING = "USB\VID_04D8&PID_F013" +VID_PID_EXPANSION3_STRING = "USB\VID_04D8&PID_EF98" +VID_PID_PYSCAN_STRING = "USB\VID_04D8&PID_EF38" diff --git a/.gitbook/assets/senet-logo-2.png b/.gitbook/assets/senet-logo-2.png new file mode 100644 index 0000000..358869a Binary files /dev/null and b/.gitbook/assets/senet-logo-2.png differ diff --git a/.gitbook/assets/senet-logo.png b/.gitbook/assets/senet-logo.png new file mode 100644 index 0000000..712b986 Binary files /dev/null and b/.gitbook/assets/senet-logo.png differ diff --git a/.gitbook/assets/senet-register-complete.png b/.gitbook/assets/senet-register-complete.png new file mode 100644 index 0000000..e2bc688 Binary files /dev/null and b/.gitbook/assets/senet-register-complete.png differ diff --git a/.gitbook/assets/senet-register.png b/.gitbook/assets/senet-register.png new file mode 100644 index 0000000..a593a08 Binary files /dev/null and b/.gitbook/assets/senet-register.png differ diff --git a/.gitbook/assets/ttn-logo.png b/.gitbook/assets/ttn-logo.png new file mode 100644 index 0000000..3f8ee50 Binary files /dev/null and b/.gitbook/assets/ttn-logo.png differ diff --git a/README.md b/README.md index 59b078c..e8c54a9 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ Welcome to the Pycom documentation site. We recommend reading through all the se To get started, read through the Getting Started guide then feel free to jump straight into the tutorials and examples in Tutorials & Examples to begin building your projects. * [Products](products.md) -* [Getting Started](gettingstarted/introduction.md) -* [Tutorials](tutorials/introduction.md) -* [Product Info](datasheets/introduction.md) -* [API Documentation](firmwareapi/introduction.md) +* [Getting Started](getting-started/introduction.md) +* [Tutorials](tutorials-and-examples/introduction.md) +* [Product Info](product-info/introduction.md) +* [API Documentation](firmware-and-api-reference/introduction.md) * [Pybytes](pybytes/introduction.md) + diff --git a/SUMMARY.md b/SUMMARY.md index 364a1da..c02254f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -5,179 +5,179 @@ ## Getting Started -* [Introduction](gettingstarted/introduction.md) -* [Hardware Setup](gettingstarted/connection/README.md) - * [LoPy](gettingstarted/connection/lopy.md) - * [LoPy 4](gettingstarted/connection/lopy4.md) - * [SiPy](gettingstarted/connection/sipy.md) - * [GPy](gettingstarted/connection/gpy.md) - * [FiPy](gettingstarted/connection/fipy.md) - * [WiPy](gettingstarted/connection/wipy.md) -* [Software](gettingstarted/installation/README.md) - * [Drivers](gettingstarted/installation/drivers.md) - * [Updating Firmware](gettingstarted/installation/firmwaretool.md) - * [Pymakr](gettingstarted/installation/pymakr.md) -* [Programming the modules](gettingstarted/programming/README.md) - * [Introduction to MicroPython](gettingstarted/programming/micropython.md) - * [MicroPython Examples](gettingstarted/programming/examples.md) - * [Your first Pymakr project](gettingstarted/programming/first-project.md) - * [REPL](gettingstarted/programming/repl/README.md) - * [Serial USB \(UART\)](gettingstarted/programming/repl/serial.md) - * [Telnet REPL](gettingstarted/programming/repl/telnet.md) - * [FTP](gettingstarted/programming/ftp.md) - * [Safe boot](gettingstarted/programming/safeboot.md) -* [Device Registration](gettingstarted/registration/README.md) - * [Sigfox](gettingstarted/registration/sigfox.md) - * [Cellular](gettingstarted/registration/cellular.md) - * [LoRaWAN](gettingstarted/registration/lora/README.md) - * [The Things Network](gettingstarted/registration/lora/ttn.md) - * [Objenious](gettingstarted/registration/lora/objenious.md) +* [Introduction](getting-started/introduction.md) +* [Hardware Setup](getting-started/connection/README.md) + * [LoPy](getting-started/connection/lopy.md) + * [LoPy 4](getting-started/connection/lopy4.md) + * [SiPy](getting-started/connection/sipy.md) + * [GPy](getting-started/connection/gpy.md) + * [FiPy](getting-started/connection/fipy.md) + * [WiPy](getting-started/connection/wipy.md) +* [Software](getting-started/installation/README.md) + * [Drivers](getting-started/installation/drivers.md) + * [Updating Firmware](getting-started/installation/firmwaretool.md) + * [Pymakr](getting-started/installation/pymakr.md) +* [Programming the modules](getting-started/programming/README.md) + * [Introduction to MicroPython](getting-started/programming/micropython.md) + * [MicroPython Examples](getting-started/programming/examples.md) + * [Your first Pymakr project](getting-started/programming/first-project.md) + * [REPL](getting-started/programming/repl/README.md) + * [Serial USB \(UART\)](getting-started/programming/repl/serial.md) + * [Telnet REPL](getting-started/programming/repl/telnet.md) + * [FTP](getting-started/programming/ftp.md) + * [Safe boot](getting-started/programming/safeboot.md) +* [Device Registration](getting-started/registration/README.md) + * [Sigfox](getting-started/registration/sigfox.md) + * [Cellular](getting-started/registration/cellular.md) + * [LoRaWAN](getting-started/registration/lora/README.md) + * [The Things Network](getting-started/registration/lora/ttn.md) + * [Objenious](getting-started/registration/lora/objenious.md) ## Pymakr Plugin -* [Installation](pymakr/installation/README.md) - * [Atom](pymakr/installation/atom.md) - * [Visual Studio Code](pymakr/installation/vscode.md) -* [Tools/Features](pymakr/toolsfeatures.md) -* [Settings](pymakr/settings.md) +* [Installation](pymakr-plugin/installation/README.md) + * [Atom](pymakr-plugin/installation/atom.md) + * [Visual Studio Code](pymakr-plugin/installation/vscode.md) +* [Tools/Features](pymakr-plugin/toolsfeatures.md) +* [Settings](pymakr-plugin/settings.md) ## Pytrack, Pysense, Pyscan -* [Introduction](pytrackpysense/introduction.md) -* [Installing Software](pytrackpysense/installation/README.md) - * [Updating Firmware](pytrackpysense/installation/firmware.md) - * [Installing Drivers - Windows 7](pytrackpysense/installation/drivers.md) - * [Installing Libraries](pytrackpysense/installation/libraries.md) -* [API Reference](pytrackpysense/apireference/README.md) - * [Pytrack](pytrackpysense/apireference/pytrack.md) - * [Pysense](pytrackpysense/apireference/pysense.md) - * [Pyscan](pytrackpysense/apireference/pyscan.md) - * [Sleep](pytrackpysense/apireference/sleep.md) +* [Introduction](pytrack-pysense-pyscan/introduction.md) +* [Installing Software](pytrack-pysense-pyscan/installation/README.md) + * [Updating Firmware](pytrack-pysense-pyscan/installation/firmware.md) + * [Installing Drivers - Windows 7](pytrack-pysense-pyscan/installation/drivers.md) + * [Installing Libraries](pytrack-pysense-pyscan/installation/libraries.md) +* [API Reference](pytrack-pysense-pyscan/apireference/README.md) + * [Pytrack](pytrack-pysense-pyscan/apireference/pytrack.md) + * [Pysense](pytrack-pysense-pyscan/apireference/pysense.md) + * [Pyscan](pytrack-pysense-pyscan/apireference/pyscan.md) + * [Sleep](pytrack-pysense-pyscan/apireference/sleep.md) ## Tutorials & Examples -* [Introduction](tutorials/introduction.md) -* [All Pycom Device Examples](tutorials/all/README.md) - * [REPL](tutorials/all/repl.md) - * [WLAN](tutorials/all/wlan.md) - * [Bluetooth](tutorials/all/ble.md) - * [HTTPS](tutorials/all/https.md) - * [MQTT](tutorials/all/mqtt.md) - * [AWS](tutorials/all/aws.md) - * [ADC](tutorials/all/adc.md) - * [I2C](tutorials/all/i2c.md) - * [Onewire Driver](tutorials/all/owd.md) - * [Threading](tutorials/all/threading.md) - * [RGB LED](tutorials/all/rgbled.md) - * [Timers](tutorials/all/timers.md) - * [PIR Sensor](tutorials/all/pir.md) - * [Modbus](tutorials/all/modbus.md) - * [OTA update](tutorials/all/ota.md) - * [RMT](tutorials/all/rmt.md) - * [Socket](tutorials/all/socket.md) -* [LoRa Examples](tutorials/lora/README.md) - * [LoRa-MAC \(Raw LoRa\)](tutorials/lora/lora-mac.md) - * [LoRaWAN with OTAA](tutorials/lora/lorawan-otaa.md) - * [LoRaWAN with ABP](tutorials/lora/lorawan-abp.md) - * [LoRa-MAC Nano-Gateway](tutorials/lora/lora-mac-nano-gateway.md) - * [LoPy to LoPy](tutorials/lora/module-module.md) - * [LoRaWAN Nano-Gateway](tutorials/lora/lorawan-nano-gateway.md) - * [RN2483 to LoPy](tutorials/lora/rn2483-to-lopy.md) - * [LoRa Mesh](tutorials/lora/lora-mesh.md) -* [Sigfox Examples](tutorials/sigfox.md) -* [LTE Examples](tutorials/lte/README.md) - * [CAT-M1](tutorials/lte/cat-m1.md) - * [NB-IoT](tutorials/lte/nb-iot.md) - * [Module IMEI](tutorials/lte/imei.md) - * [Modem Firmware Update](tutorials/lte/firmware.md) -* [Pytrack Examples](tutorials/pytrack.md) -* [Pysense Examples](tutorials/pysense.md) -* [Pyscan Examples](tutorials/pyscan.md) +* [Introduction](tutorials-and-examples/introduction.md) +* [All Pycom Device Examples](tutorials-and-examples/all/README.md) + * [REPL](tutorials-and-examples/all/repl.md) + * [WLAN](tutorials-and-examples/all/wlan.md) + * [Bluetooth](tutorials-and-examples/all/ble.md) + * [HTTPS](tutorials-and-examples/all/https.md) + * [MQTT](tutorials-and-examples/all/mqtt.md) + * [AWS](tutorials-and-examples/all/aws.md) + * [ADC](tutorials-and-examples/all/adc.md) + * [I2C](tutorials-and-examples/all/i2c.md) + * [Onewire Driver](tutorials-and-examples/all/owd.md) + * [Threading](tutorials-and-examples/all/threading.md) + * [RGB LED](tutorials-and-examples/all/rgbled.md) + * [Timers](tutorials-and-examples/all/timers.md) + * [PIR Sensor](tutorials-and-examples/all/pir.md) + * [Modbus](tutorials-and-examples/all/modbus.md) + * [OTA update](tutorials-and-examples/all/ota.md) + * [RMT](tutorials-and-examples/all/rmt.md) + * [Socket](tutorials-and-examples/all/socket.md) +* [LoRa Examples](tutorials-and-examples/lora/README.md) + * [LoRa-MAC \(Raw LoRa\)](tutorials-and-examples/lora/lora-mac.md) + * [LoRaWAN with OTAA](tutorials-and-examples/lora/lorawan-otaa.md) + * [LoRaWAN with ABP](tutorials-and-examples/lora/lorawan-abp.md) + * [LoRa-MAC Nano-Gateway](tutorials-and-examples/lora/lora-mac-nano-gateway.md) + * [LoPy to LoPy](tutorials-and-examples/lora/module-module.md) + * [LoRaWAN Nano-Gateway](tutorials-and-examples/lora/lorawan-nano-gateway.md) + * [RN2483 to LoPy](tutorials-and-examples/lora/rn2483-to-lopy.md) + * [LoRa Mesh](tutorials-and-examples/lora/lora-mesh.md) +* [Sigfox Examples](tutorials-and-examples/sigfox.md) +* [LTE Examples](tutorials-and-examples/lte/README.md) + * [CAT-M1](tutorials-and-examples/lte/cat-m1.md) + * [NB-IoT](tutorials-and-examples/lte/nb-iot.md) + * [Module IMEI](tutorials-and-examples/lte/imei.md) + * [Modem Firmware Update](tutorials-and-examples/lte/firmware.md) +* [Pytrack Examples](tutorials-and-examples/pytrack.md) +* [Pysense Examples](tutorials-and-examples/pysense.md) +* [Pyscan Examples](tutorials-and-examples/pyscan.md) ## Firmware & API Reference -* [Introduction](firmwareapi/introduction.md) -* [Pycom Modules](firmwareapi/pycom/README.md) - * [machine](firmwareapi/pycom/machine/README.md) - * [ADC](firmwareapi/pycom/machine/adc.md) - * [DAC](firmwareapi/pycom/machine/dac.md) - * [I2C](firmwareapi/pycom/machine/i2c.md) - * [Pin](firmwareapi/pycom/machine/pin.md) - * [PWM](firmwareapi/pycom/machine/pwm.md) - * [RTC](firmwareapi/pycom/machine/rtc.md) - * [SPI](firmwareapi/pycom/machine/spi.md) - * [UART](firmwareapi/pycom/machine/uart.md) - * [WDT](firmwareapi/pycom/machine/wdt.md) - * [Timer](firmwareapi/pycom/machine/timer.md) - * [SD](firmwareapi/pycom/machine/sd.md) - * [CAN](firmwareapi/pycom/machine/can.md) - * [RMT](firmwareapi/pycom/machine/rmt.md) - * [network](firmwareapi/pycom/network/README.md) - * [WLAN](firmwareapi/pycom/network/wlan.md) - * [Server](firmwareapi/pycom/network/server.md) - * [Bluetooth](firmwareapi/pycom/network/bluetooth/README.md) - * [GATT](firmwareapi/pycom/network/bluetooth/gatt.md) - * [GATTCConnection](firmwareapi/pycom/network/bluetooth/gattcconnection.md) - * [GATTCService](firmwareapi/pycom/network/bluetooth/gattccservice.md) - * [GATTCCharacteristic](firmwareapi/pycom/network/bluetooth/gattccharacteristic.md) - * [GATTSService](firmwareapi/pycom/network/bluetooth/gattsservice.md) - * [GATTSCharacteristic](firmwareapi/pycom/network/bluetooth/gattscharacteristic.md) - * [LoRa](firmwareapi/pycom/network/lora.md) - * [Sigfox](firmwareapi/pycom/network/sigfox.md) - * [LTE](firmwareapi/pycom/network/lte.md) - * [AES](firmwareapi/pycom/aes.md) - * [pycom](firmwareapi/pycom/pycom.md) -* [MicroPython Modules](firmwareapi/micropython/README.md) - * [micropython](firmwareapi/micropython/micropython.md) - * [uctypes](firmwareapi/micropython/uctypes.md) - * [sys](firmwareapi/micropython/sys.md) - * [uos](firmwareapi/micropython/uos.md) - * [array](firmwareapi/micropython/array.md) - * [cmath](firmwareapi/micropython/cmath.md) - * [math](firmwareapi/micropython/math.md) - * [gc](firmwareapi/micropython/gc.md) - * [ubinascii](firmwareapi/micropython/ubinascii.md) - * [ujson](firmwareapi/micropython/ujson.md) - * [ure](firmwareapi/micropython/ure.md) - * [usocket](firmwareapi/micropython/usocket.md) - * [select](firmwareapi/micropython/select.md) - * [utime](firmwareapi/micropython/utime.md) - * [uhashlib](firmwareapi/micropython/uhashlib.md) - * [ussl](firmwareapi/micropython/ussl.md) - * [ucrypto](firmwareapi/micropython/ucrypto.md) - * [ustruct](firmwareapi/micropython/ustruct/README.md) - * [uzlib](firmwareapi/micropython/ustruct/uzlib.md) - * [\_thread](firmwareapi/micropython/_thread.md) - * [Builtin](firmwareapi/micropython/builtin.md) -* [Notes](firmwareapi/notes.md) +* [Introduction](firmware-and-api-reference/introduction.md) +* [Pycom Modules](firmware-and-api-reference/pycom/README.md) + * [machine](firmware-and-api-reference/pycom/machine/README.md) + * [ADC](firmware-and-api-reference/pycom/machine/adc.md) + * [DAC](firmware-and-api-reference/pycom/machine/dac.md) + * [I2C](firmware-and-api-reference/pycom/machine/i2c.md) + * [Pin](firmware-and-api-reference/pycom/machine/pin.md) + * [PWM](firmware-and-api-reference/pycom/machine/pwm.md) + * [RTC](firmware-and-api-reference/pycom/machine/rtc.md) + * [SPI](firmware-and-api-reference/pycom/machine/spi.md) + * [UART](firmware-and-api-reference/pycom/machine/uart.md) + * [WDT](firmware-and-api-reference/pycom/machine/wdt.md) + * [Timer](firmware-and-api-reference/pycom/machine/timer.md) + * [SD](firmware-and-api-reference/pycom/machine/sd.md) + * [CAN](firmware-and-api-reference/pycom/machine/can.md) + * [RMT](firmware-and-api-reference/pycom/machine/rmt.md) + * [network](firmware-and-api-reference/pycom/network/README.md) + * [WLAN](firmware-and-api-reference/pycom/network/wlan.md) + * [Server](firmware-and-api-reference/pycom/network/server.md) + * [Bluetooth](firmware-and-api-reference/pycom/network/bluetooth/README.md) + * [GATT](firmware-and-api-reference/pycom/network/bluetooth/gatt.md) + * [GATTCConnection](firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md) + * [GATTCService](firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md) + * [GATTCCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md) + * [GATTSService](firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md) + * [GATTSCharacteristic](firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md) + * [LoRa](firmware-and-api-reference/pycom/network/lora.md) + * [Sigfox](firmware-and-api-reference/pycom/network/sigfox.md) + * [LTE](firmware-and-api-reference/pycom/network/lte.md) + * [AES](firmware-and-api-reference/pycom/aes.md) + * [pycom](firmware-and-api-reference/pycom/pycom.md) +* [MicroPython Modules](firmware-and-api-reference/micropython/README.md) + * [micropython](firmware-and-api-reference/micropython/micropython.md) + * [uctypes](firmware-and-api-reference/micropython/uctypes.md) + * [sys](firmware-and-api-reference/micropython/sys.md) + * [uos](firmware-and-api-reference/micropython/uos.md) + * [array](firmware-and-api-reference/micropython/array.md) + * [cmath](firmware-and-api-reference/micropython/cmath.md) + * [math](firmware-and-api-reference/micropython/math.md) + * [gc](firmware-and-api-reference/micropython/gc.md) + * [ubinascii](firmware-and-api-reference/micropython/ubinascii.md) + * [ujson](firmware-and-api-reference/micropython/ujson.md) + * [ure](firmware-and-api-reference/micropython/ure.md) + * [usocket](firmware-and-api-reference/micropython/usocket.md) + * [select](firmware-and-api-reference/micropython/select.md) + * [utime](firmware-and-api-reference/micropython/utime.md) + * [uhashlib](firmware-and-api-reference/micropython/uhashlib.md) + * [ussl](firmware-and-api-reference/micropython/ussl.md) + * [ucrypto](firmware-and-api-reference/micropython/ucrypto.md) + * [ustruct](firmware-and-api-reference/micropython/ustruct/README.md) + * [uzlib](firmware-and-api-reference/micropython/ustruct/uzlib.md) + * [\_thread](firmware-and-api-reference/micropython/_thread.md) + * [Builtin](firmware-and-api-reference/micropython/builtin.md) +* [Notes](firmware-and-api-reference/notes.md) ## Product Info -* [Introduction](datasheets/introduction.md) -* [Development Modules](datasheets/development/README.md) - * [WiPy 2.0](datasheets/development/wipy2.md) - * [WiPy 3.0](datasheets/development/wipy3.md) - * [LoPy](datasheets/development/lopy.md) - * [LoPy 4](datasheets/development/lopy4.md) - * [SiPy](datasheets/development/sipy.md) - * [GPy](datasheets/development/gpy.md) - * [FiPy](datasheets/development/fipy.md) -* [OEM Modules](datasheets/oem/README.md) - * [W01](datasheets/oem/w01.md) - * [L01](datasheets/oem/l01.md) - * [L04](datasheets/oem/l04.md) - * [G01](datasheets/oem/g01.md) - * [L01 OEM Baseboard Reference](datasheets/oem/l01_reference.md) - * [Universal OEM Baseboard Reference](datasheets/oem/universal_reference.md) -* [Expansion Boards and Shields](datasheets/boards/README.md) - * [Expansion Board 3.0](datasheets/boards/expansion3.md) - * [Pytrack](datasheets/boards/pytrack.md) - * [Pysense](datasheets/boards/pysense.md) - * [Pyscan](datasheets/boards/pyscan.md) - * [Expansion Board 2.0](datasheets/boards/expansion2.md) - * [Deep Sleep Shield](datasheets/boards/deepsleep/README.md) - * [Deep Sleep API](datasheets/boards/deepsleep/api.md) -* [Notes](datasheets/notes.md) +* [Introduction](product-info/introduction.md) +* [Development Modules](product-info/development/README.md) + * [WiPy 2.0](product-info/development/wipy2.md) + * [WiPy 3.0](product-info/development/wipy3.md) + * [LoPy](product-info/development/lopy.md) + * [LoPy 4](product-info/development/lopy4.md) + * [SiPy](product-info/development/sipy.md) + * [GPy](product-info/development/gpy.md) + * [FiPy](product-info/development/fipy.md) +* [OEM Modules](product-info/oem/README.md) + * [W01](product-info/oem/w01.md) + * [L01](product-info/oem/l01.md) + * [L04](product-info/oem/l04.md) + * [G01](product-info/oem/g01.md) + * [L01 OEM Baseboard Reference](product-info/oem/l01_reference.md) + * [Universal OEM Baseboard Reference](product-info/oem/universal_reference.md) +* [Expansion Boards and Shields](product-info/boards/README.md) + * [Expansion Board 3.0](product-info/boards/expansion3.md) + * [Pytrack](product-info/boards/pytrack.md) + * [Pysense](product-info/boards/pysense.md) + * [Pyscan](product-info/boards/pyscan.md) + * [Expansion Board 2.0](product-info/boards/expansion2.md) + * [Deep Sleep Shield](product-info/boards/deepsleep/README.md) + * [Deep Sleep API](product-info/boards/deepsleep/api.md) +* [Notes](product-info/notes.md) ## Pybytes @@ -190,20 +190,22 @@ * [DevKit contract](pybytes/connect/sigfox/devkit.md) * [Custom contract](pybytes/connect/sigfox/custom.md) * [Visualise data from your device](pybytes/dashboard.md) +* [Integrations](pybytes/integrations/README.md) + * [Amazon IoT](pybytes/integrations/amazon-iot.md) ## Documentation Notes -* [Introduction](docnotes/introduction.md) -* [Syntax](docnotes/syntax.md) -* [REPL vs Scripts](docnotes/replscript.md) -* [Mesh Networks](docnotes/mesh-networks.md) +* [Introduction](documentation-notes/introduction.md) +* [Syntax](documentation-notes/syntax.md) +* [REPL vs Scripts](documentation-notes/replscript.md) +* [Mesh Networks](documentation-notes/mesh-networks.md) ## Advanced Topics -* [Firmware Downgrade](advance/downgrade.md) -* [CLI Updater](advance/cli.md) -* [SecureBoot and Encryption](advance/encryption.md) -* [License](license.md) +* [Firmware Downgrade](advanced-topics/downgrade.md) +* [CLI Updater](advanced-topics/cli.md) +* [SecureBoot and Encryption](advanced-topics/encryption.md) +* [License](advanced-topics/license.md) ## Have a question? diff --git a/advance/cli.md b/advanced-topics/cli.md similarity index 99% rename from advance/cli.md rename to advanced-topics/cli.md index 75aaafd..e367c85 100644 --- a/advance/cli.md +++ b/advanced-topics/cli.md @@ -325,7 +325,7 @@ To restore your OTA block: `$pycom-fwtool-cli -p PORT ota -r -f backup.ota` #### lpwan -Get/Set LPWAN parameters saved to non-volatile storage. Please see [here](../firmwareapi/pycom/network/lora.md##loranvramsave) for more details. +Get/Set LPWAN parameters saved to non-volatile storage. Please see [here](../firmware-and-api-reference/pycom/network/lora.md##loranvramsave) for more details. ```text usage: pycom-fwtool-cli -p PORT lpwan [-h] [--region REGION] diff --git a/advance/downgrade.md b/advanced-topics/downgrade.md similarity index 100% rename from advance/downgrade.md rename to advanced-topics/downgrade.md diff --git a/advance/encryption.md b/advanced-topics/encryption.md similarity index 100% rename from advance/encryption.md rename to advanced-topics/encryption.md diff --git a/license.md b/advanced-topics/license.md similarity index 100% rename from license.md rename to advanced-topics/license.md diff --git a/docnotes/mesh-networks.md b/docnotes/mesh-networks.md deleted file mode 100644 index 5b76ef6..0000000 --- a/docnotes/mesh-networks.md +++ /dev/null @@ -1,4 +0,0 @@ -# Mesh Networks - -Mesh Networking is currently under development. Please click [here](../tutorials/lora/lora-mesh.md) for the documentation. Please keep in mind that this document is still only informational. - diff --git a/docnotes/introduction.md b/documentation-notes/introduction.md similarity index 100% rename from docnotes/introduction.md rename to documentation-notes/introduction.md diff --git a/documentation-notes/mesh-networks.md b/documentation-notes/mesh-networks.md new file mode 100644 index 0000000..cad6206 --- /dev/null +++ b/documentation-notes/mesh-networks.md @@ -0,0 +1,4 @@ +# Mesh Networks + +Mesh Networking is currently under development. Please click [here](../tutorials-and-examples/lora/lora-mesh.md) for the documentation. Please keep in mind that this document is still only informational. + diff --git a/docnotes/replscript.md b/documentation-notes/replscript.md similarity index 100% rename from docnotes/replscript.md rename to documentation-notes/replscript.md diff --git a/docnotes/syntax.md b/documentation-notes/syntax.md similarity index 100% rename from docnotes/syntax.md rename to documentation-notes/syntax.md diff --git a/firmwareapi/introduction.md b/firmware-and-api-reference/introduction.md similarity index 100% rename from firmwareapi/introduction.md rename to firmware-and-api-reference/introduction.md diff --git a/firmwareapi/micropython/README.md b/firmware-and-api-reference/micropython/README.md similarity index 100% rename from firmwareapi/micropython/README.md rename to firmware-and-api-reference/micropython/README.md diff --git a/firmwareapi/micropython/_thread.md b/firmware-and-api-reference/micropython/_thread.md similarity index 100% rename from firmwareapi/micropython/_thread.md rename to firmware-and-api-reference/micropython/_thread.md diff --git a/firmwareapi/micropython/array.md b/firmware-and-api-reference/micropython/array.md similarity index 100% rename from firmwareapi/micropython/array.md rename to firmware-and-api-reference/micropython/array.md diff --git a/firmwareapi/micropython/builtin.md b/firmware-and-api-reference/micropython/builtin.md similarity index 100% rename from firmwareapi/micropython/builtin.md rename to firmware-and-api-reference/micropython/builtin.md diff --git a/firmwareapi/micropython/cmath.md b/firmware-and-api-reference/micropython/cmath.md similarity index 100% rename from firmwareapi/micropython/cmath.md rename to firmware-and-api-reference/micropython/cmath.md diff --git a/firmwareapi/micropython/gc.md b/firmware-and-api-reference/micropython/gc.md similarity index 100% rename from firmwareapi/micropython/gc.md rename to firmware-and-api-reference/micropython/gc.md diff --git a/firmwareapi/micropython/math.md b/firmware-and-api-reference/micropython/math.md similarity index 100% rename from firmwareapi/micropython/math.md rename to firmware-and-api-reference/micropython/math.md diff --git a/firmwareapi/micropython/micropython.md b/firmware-and-api-reference/micropython/micropython.md similarity index 100% rename from firmwareapi/micropython/micropython.md rename to firmware-and-api-reference/micropython/micropython.md diff --git a/firmwareapi/micropython/select.md b/firmware-and-api-reference/micropython/select.md similarity index 100% rename from firmwareapi/micropython/select.md rename to firmware-and-api-reference/micropython/select.md diff --git a/firmwareapi/micropython/sys.md b/firmware-and-api-reference/micropython/sys.md similarity index 100% rename from firmwareapi/micropython/sys.md rename to firmware-and-api-reference/micropython/sys.md diff --git a/firmwareapi/micropython/ubinascii.md b/firmware-and-api-reference/micropython/ubinascii.md similarity index 100% rename from firmwareapi/micropython/ubinascii.md rename to firmware-and-api-reference/micropython/ubinascii.md diff --git a/firmwareapi/micropython/ucrypto.md b/firmware-and-api-reference/micropython/ucrypto.md similarity index 100% rename from firmwareapi/micropython/ucrypto.md rename to firmware-and-api-reference/micropython/ucrypto.md diff --git a/firmwareapi/micropython/uctypes.md b/firmware-and-api-reference/micropython/uctypes.md similarity index 100% rename from firmwareapi/micropython/uctypes.md rename to firmware-and-api-reference/micropython/uctypes.md diff --git a/firmwareapi/micropython/uhashlib.md b/firmware-and-api-reference/micropython/uhashlib.md similarity index 100% rename from firmwareapi/micropython/uhashlib.md rename to firmware-and-api-reference/micropython/uhashlib.md diff --git a/firmwareapi/micropython/ujson.md b/firmware-and-api-reference/micropython/ujson.md similarity index 100% rename from firmwareapi/micropython/ujson.md rename to firmware-and-api-reference/micropython/ujson.md diff --git a/firmwareapi/micropython/uos.md b/firmware-and-api-reference/micropython/uos.md similarity index 100% rename from firmwareapi/micropython/uos.md rename to firmware-and-api-reference/micropython/uos.md diff --git a/firmwareapi/micropython/ure.md b/firmware-and-api-reference/micropython/ure.md similarity index 100% rename from firmwareapi/micropython/ure.md rename to firmware-and-api-reference/micropython/ure.md diff --git a/firmwareapi/micropython/usocket.md b/firmware-and-api-reference/micropython/usocket.md similarity index 100% rename from firmwareapi/micropython/usocket.md rename to firmware-and-api-reference/micropython/usocket.md diff --git a/firmwareapi/micropython/ussl.md b/firmware-and-api-reference/micropython/ussl.md similarity index 100% rename from firmwareapi/micropython/ussl.md rename to firmware-and-api-reference/micropython/ussl.md diff --git a/firmwareapi/micropython/ustruct/README.md b/firmware-and-api-reference/micropython/ustruct/README.md similarity index 100% rename from firmwareapi/micropython/ustruct/README.md rename to firmware-and-api-reference/micropython/ustruct/README.md diff --git a/firmwareapi/micropython/ustruct/uzlib.md b/firmware-and-api-reference/micropython/ustruct/uzlib.md similarity index 97% rename from firmwareapi/micropython/ustruct/uzlib.md rename to firmware-and-api-reference/micropython/ustruct/uzlib.md index a181bda..d063886 100644 --- a/firmwareapi/micropython/ustruct/uzlib.md +++ b/firmware-and-api-reference/micropython/ustruct/uzlib.md @@ -1,7 +1,3 @@ ---- -description: zlib decompression ---- - # uzlib _This module implements a subset of the corresponding_ `CPython` _module, as described below. For more information, refer to the original CPython documentation:_ `zlib`. diff --git a/firmwareapi/micropython/utime.md b/firmware-and-api-reference/micropython/utime.md similarity index 100% rename from firmwareapi/micropython/utime.md rename to firmware-and-api-reference/micropython/utime.md diff --git a/firmwareapi/notes.md b/firmware-and-api-reference/notes.md similarity index 100% rename from firmwareapi/notes.md rename to firmware-and-api-reference/notes.md diff --git a/firmwareapi/pycom/README.md b/firmware-and-api-reference/pycom/README.md similarity index 100% rename from firmwareapi/pycom/README.md rename to firmware-and-api-reference/pycom/README.md diff --git a/firmwareapi/pycom/aes.md b/firmware-and-api-reference/pycom/aes.md similarity index 100% rename from firmwareapi/pycom/aes.md rename to firmware-and-api-reference/pycom/aes.md diff --git a/firmwareapi/pycom/machine/README.md b/firmware-and-api-reference/pycom/machine/README.md similarity index 100% rename from firmwareapi/pycom/machine/README.md rename to firmware-and-api-reference/pycom/machine/README.md diff --git a/firmwareapi/pycom/machine/adc.md b/firmware-and-api-reference/pycom/machine/adc.md similarity index 100% rename from firmwareapi/pycom/machine/adc.md rename to firmware-and-api-reference/pycom/machine/adc.md diff --git a/firmwareapi/pycom/machine/can.md b/firmware-and-api-reference/pycom/machine/can.md similarity index 100% rename from firmwareapi/pycom/machine/can.md rename to firmware-and-api-reference/pycom/machine/can.md diff --git a/firmwareapi/pycom/machine/dac.md b/firmware-and-api-reference/pycom/machine/dac.md similarity index 100% rename from firmwareapi/pycom/machine/dac.md rename to firmware-and-api-reference/pycom/machine/dac.md diff --git a/firmwareapi/pycom/machine/i2c.md b/firmware-and-api-reference/pycom/machine/i2c.md similarity index 100% rename from firmwareapi/pycom/machine/i2c.md rename to firmware-and-api-reference/pycom/machine/i2c.md diff --git a/firmwareapi/pycom/machine/pin.md b/firmware-and-api-reference/pycom/machine/pin.md similarity index 100% rename from firmwareapi/pycom/machine/pin.md rename to firmware-and-api-reference/pycom/machine/pin.md diff --git a/firmwareapi/pycom/machine/pwm.md b/firmware-and-api-reference/pycom/machine/pwm.md similarity index 100% rename from firmwareapi/pycom/machine/pwm.md rename to firmware-and-api-reference/pycom/machine/pwm.md diff --git a/firmwareapi/pycom/machine/rmt.md b/firmware-and-api-reference/pycom/machine/rmt.md similarity index 100% rename from firmwareapi/pycom/machine/rmt.md rename to firmware-and-api-reference/pycom/machine/rmt.md diff --git a/firmwareapi/pycom/machine/rtc.md b/firmware-and-api-reference/pycom/machine/rtc.md similarity index 100% rename from firmwareapi/pycom/machine/rtc.md rename to firmware-and-api-reference/pycom/machine/rtc.md diff --git a/firmwareapi/pycom/machine/sd.md b/firmware-and-api-reference/pycom/machine/sd.md similarity index 100% rename from firmwareapi/pycom/machine/sd.md rename to firmware-and-api-reference/pycom/machine/sd.md diff --git a/firmwareapi/pycom/machine/spi.md b/firmware-and-api-reference/pycom/machine/spi.md similarity index 100% rename from firmwareapi/pycom/machine/spi.md rename to firmware-and-api-reference/pycom/machine/spi.md diff --git a/firmwareapi/pycom/machine/timer.md b/firmware-and-api-reference/pycom/machine/timer.md similarity index 100% rename from firmwareapi/pycom/machine/timer.md rename to firmware-and-api-reference/pycom/machine/timer.md diff --git a/firmwareapi/pycom/machine/uart.md b/firmware-and-api-reference/pycom/machine/uart.md similarity index 100% rename from firmwareapi/pycom/machine/uart.md rename to firmware-and-api-reference/pycom/machine/uart.md diff --git a/firmwareapi/pycom/machine/wdt.md b/firmware-and-api-reference/pycom/machine/wdt.md similarity index 100% rename from firmwareapi/pycom/machine/wdt.md rename to firmware-and-api-reference/pycom/machine/wdt.md diff --git a/firmwareapi/pycom/network/README.md b/firmware-and-api-reference/pycom/network/README.md similarity index 100% rename from firmwareapi/pycom/network/README.md rename to firmware-and-api-reference/pycom/network/README.md diff --git a/firmwareapi/pycom/network/bluetooth/README.md b/firmware-and-api-reference/pycom/network/bluetooth/README.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/README.md rename to firmware-and-api-reference/pycom/network/bluetooth/README.md diff --git a/firmwareapi/pycom/network/bluetooth/gatt.md b/firmware-and-api-reference/pycom/network/bluetooth/gatt.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gatt.md rename to firmware-and-api-reference/pycom/network/bluetooth/gatt.md diff --git a/firmwareapi/pycom/network/bluetooth/gattccharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gattccharacteristic.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattccharacteristic.md diff --git a/firmwareapi/pycom/network/bluetooth/gattcconnection.md b/firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gattcconnection.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattcconnection.md diff --git a/firmwareapi/pycom/network/bluetooth/gattccservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gattccservice.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattccservice.md diff --git a/firmwareapi/pycom/network/bluetooth/gattscharacteristic.md b/firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gattscharacteristic.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattscharacteristic.md diff --git a/firmwareapi/pycom/network/bluetooth/gattsservice.md b/firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md similarity index 100% rename from firmwareapi/pycom/network/bluetooth/gattsservice.md rename to firmware-and-api-reference/pycom/network/bluetooth/gattsservice.md diff --git a/firmwareapi/pycom/network/lora.md b/firmware-and-api-reference/pycom/network/lora.md similarity index 100% rename from firmwareapi/pycom/network/lora.md rename to firmware-and-api-reference/pycom/network/lora.md diff --git a/firmwareapi/pycom/network/lte.md b/firmware-and-api-reference/pycom/network/lte.md similarity index 99% rename from firmwareapi/pycom/network/lte.md rename to firmware-and-api-reference/pycom/network/lte.md index 1a07057..460b521 100644 --- a/firmwareapi/pycom/network/lte.md +++ b/firmware-and-api-reference/pycom/network/lte.md @@ -12,7 +12,7 @@ The GPy and FiPy support both new LTE-M protocols: {% endhint %} {% hint style="info" %} -The Sequans modem used on Pycom's cellular enabled modules can only work in one of these modes at a time. In order to switch between the two protocols you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](../../../tutorials/lte/firmware.md). +The Sequans modem used on Pycom's cellular enabled modules can only work in one of these modes at a time. In order to switch between the two protocols you need to flash a different firmware to the Sequans modem. Instructions for this can be found [here](../../../tutorials-and-examples/lte/firmware.md). {% endhint %} ## AT Commands diff --git a/firmwareapi/pycom/network/server.md b/firmware-and-api-reference/pycom/network/server.md similarity index 100% rename from firmwareapi/pycom/network/server.md rename to firmware-and-api-reference/pycom/network/server.md diff --git a/firmwareapi/pycom/network/sigfox.md b/firmware-and-api-reference/pycom/network/sigfox.md similarity index 100% rename from firmwareapi/pycom/network/sigfox.md rename to firmware-and-api-reference/pycom/network/sigfox.md diff --git a/firmwareapi/pycom/network/wlan.md b/firmware-and-api-reference/pycom/network/wlan.md similarity index 58% rename from firmwareapi/pycom/network/wlan.md rename to firmware-and-api-reference/pycom/network/wlan.md index 73d2f15..1612b55 100644 --- a/firmwareapi/pycom/network/wlan.md +++ b/firmware-and-api-reference/pycom/network/wlan.md @@ -34,7 +34,7 @@ print(wlan.ifconfig()) ## Constructors -#### class network.WLAN\(id=0, ...\) +### class network.WLAN\(id=0, ...\) Create a WLAN object, and optionally configure it. See [`init`](wlan.md#wlan-init-mode-ssid-none-auth-none-channel-1-antenna-none-power_save-false-hidden-false) for params of configuration. @@ -44,7 +44,7 @@ The WLAN constructor is special in the sense that if no arguments besides the `i ## Methods -##### wlan.init(mode, * , ssid=None, auth=None, channel=1, antenna=None, power_save=False, hidden=False, bandwidth=HT40, max\_tx\_pwr=20, country=CN) +#### wlan.init\(mode, \* , ssid=None, auth=None, channel=1, antenna=None, power\_save=False, hidden=False, bandwidth=HT40, max\_tx\_pwr=20, country=CN\) Set or get the WiFi network processor configuration. @@ -62,10 +62,8 @@ Arguments are: * `power_save` enables or disables power save functions in `STA` mode. * `hidden` only valid in `WLAN.AP` mode to create an access point with a hidden SSID when set to `True`. * `bandwidth` is the Bandwidth to use, either 20MHz or 40 MHz , use `HT20` or `HT40` - -- ``max_tx_pwr`` is the maximum WiFi Tx power allowed. see `WLAN.max_tx_power()` for more details - -- ``country`` tuple representing the country configuration parameters. see `WLAN.country()` for more details +* `max_tx_pwr` is the maximum WiFi Tx power allowed. see `WLAN.max_tx_power()` for more details +* `country` tuple representing the country configuration parameters. see `WLAN.country()` for more details For example, you can do: @@ -81,11 +79,11 @@ or wlan.init(mode=WLAN.STA) ``` -#### wlan.deinit\(\) +### wlan.deinit\(\) Disables the WiFi radio. -#### wlan.connect\(ssid, \* , auth=None, bssid=None, timeout=None, ca\_certs=None, keyfile=None, certfile=None, identity=None, hostname=None\) +### wlan.connect\(ssid, \* , auth=None, bssid=None, timeout=None, ca\_certs=None, keyfile=None, certfile=None, identity=None, hostname=None\) Connect to a wifi access point using the given SSID, and other security parameters. @@ -104,56 +102,44 @@ Connect to a wifi access point using the given SSID, and other security paramete The ESP32 only handles certificates with `pkcs8` format \(but not the "Traditional SSLeay RSAPrivateKey" format\). The private key should be RSA coded with 2048 bits at maximum. {% endhint %} -##### wlan.scan([ssid=NULL, bssid=NULL, channel=0, show_hidden=False, type=WLAN.SCAN\_ACTIVE, scantime=120ms]) +#### wlan.scan\(\[ssid=NULL, bssid=NULL, channel=0, show\_hidden=False, type=WLAN.SCAN\_ACTIVE, scantime=120ms\]\) -Performs a network scan and returns a list of named tuples with (ssid, bssid, sec, channel, rssi). When no config args passed scan will be performed with default configurations. +Performs a network scan and returns a list of named tuples with \(ssid, bssid, sec, channel, rssi\). When no config args passed scan will be performed with default configurations. -Note: For Fast scan mode ssid/bssid and channel should be +Note: For Fast scan mode ssid/bssid and channel should be -- ``ssid`` : If the SSID is not NULL, it is only the AP with the same SSID that can be scanned. +* `ssid` : If the SSID is not NULL, it is only the AP with the same SSID that can be scanned. +* `bssid` : If the BSSID is not NULL, it is only the AP with the same BSSID that can be scanned. The bssid is given as 6 Hexadecimal bytes literals \(i.e b'\xff\xff\xff\xff\xff\xff'\) +* `channel` : If “channel” is 0, there will be an all-channel scan; otherwise, there will be a specific-channel scan. +* `show_hidden` : If “show\_hidden” is 0, the scan ignores the AP with a hidden SSID; otherwise, the scan considers the hidden AP a normal one. +* `type` : If “type” is `WLAN.SCAN_ACTIVE`, the scan is “active”; otherwise, it is a “passive” one. + * Active Scan is performed by sending a probe request. The default scan is an active scan + * Passive Scan sends no probe request. Just switch to the specific channel and wait for a beacon. +* `scantime` : -- ``bssid`` : If the BSSID is not NULL, it is only the AP with the same BSSID that can be scanned. The bssid is given as 6 Hexadecimal bytes literals (i.e b'\xff\xff\xff\xff\xff\xff') + This field is used to control how long the scan dwells on each channel. For passive scans, scantime=\[int\] designates the dwell time for each channel. -- ``channel`` : If “channel” is 0, there will be an all-channel scan; otherwise, there will be a specific-channel scan. - -- ``show_hidden`` : If “show_hidden” is 0, the scan ignores the AP with a hidden SSID; otherwise, the scan considers the hidden AP a normal one. - -- ``type`` : If “type” is `WLAN.SCAN_ACTIVE`, the scan is “active”; otherwise, it is a “passive” one. - - - Active Scan is performed by sending a probe request. The default scan is an active scan - - - Passive Scan sends no probe request. Just switch to the specific channel and wait for a beacon. - -- ``scantime`` : - - This field is used to control how long the scan dwells on each channel. - For passive scans, scantime=[int] designates the dwell time for each channel. - - For active scans, dwell times for each channel are listed below. - scantime is given as a tuple for min and max times (min,max) - - {% hint style='danger' %} - - min=0, max=0: scan dwells on each channel for 120 ms. - - min>0, max=0: scan dwells on each channel for 120 ms. - - min=0, max>0: scan dwells on each channel for max ms. - - min>0, max>0: The minimum time the scan dwells on each channel is min ms. If no AP is found during this time frame, the scan switches to the next channel. Otherwise, the scan dwells on the channel for max ms.If you want to improve the performance of the the scan, you can try to modify these two parameters. - -{% endhint %} + For active scans, dwell times for each channel are listed below. scantime is given as a tuple for min and max times \(min,max\) -#### wlan.disconnect\(\) + + min=0, max=0: scan dwells on each channel for 120 ms. + + min>0, max=0: scan dwells on each channel for 120 ms. + + min=0, max>0: scan dwells on each channel for max ms. + + min>0, max>0: The minimum time the scan dwells on each channel is min ms. If no AP is found during this time frame, the scan switches to the next channel. Otherwise, the scan dwells on the channel for max ms.If you want to improve the performance of the the scan, you can try to modify these two parameters. + +### wlan.disconnect\(\) Disconnect from the WiFi access point. -#### wlan.isconnected\(\) +### wlan.isconnected\(\) In case of STA mode, returns `True` if connected to a WiFi access point and has a valid IP address. In AP mode returns `True` when a station is connected, `False` otherwise. -#### wlan.ifconfig\(id=0, config=\['dhcp' or configtuple\]\) +### wlan.ifconfig\(id=0, config=\['dhcp' or configtuple\]\) When `id` is 0, the configuration will be get/set on the Station interface. When `id` is 1 the configuration will be done for the AP interface. @@ -167,13 +153,13 @@ If the 4-tuple config is given then a static IP is configured. For instance: wlan.ifconfig(config=('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8')) ``` -#### wlan.mode\(\[mode\]\) +### wlan.mode\(\[mode\]\) Get or set the WLAN mode. -#### wlan.ssid\(\[ssid\]\) +### wlan.ssid\(\[ssid\]\) -Get or set the SSID (Set SSID of AP). +Get or set the SSID \(Set SSID of AP\). In case if mode = `WLAN.STA` this method can get the ssid of AP the board is connected to. @@ -181,39 +167,37 @@ In case of mode = `WLAN.AP` this method can get the ssid of the board's own AP. In case of mode = `WLAN.STA_AP` this method can get the ssid of board's own AP plus the AP the STA is connected to in form of a tuple: - _\_ - - -#### wlan.auth\(\[auth\]\) +_\_ + +### wlan.auth\(\[auth\]\) Get or set the authentication type when in AP mode. -#### wlan.channel\(\[channel, sec_chn\]\) +### wlan.channel\(\[channel, sec\_chn\]\) -*In AP mode:* +_In AP mode:_ Get or set the wifi channel -*In STA mode:* +_In STA mode:_ -``channel``: is the primary channel to listen to. +`channel`: is the primary channel to listen to. -``sec_chn`` : Only in case of Bandwidth = HT40 this should specify the position of the secondary channel weather above or below primary channel. -`WLAN.SEC_CHN_POS_ABOVE` or `WLAN.SEC_CHN_POS_BELOW` +`sec_chn` : Only in case of Bandwidth = HT40 this should specify the position of the secondary channel weather above or below primary channel. `WLAN.SEC_CHN_POS_ABOVE` or `WLAN.SEC_CHN_POS_BELOW` _Note: Setting Channel in STA mode is only Allowed in Promiscuous mode_ -#### wlan.antenna\(\[antenna\]\) +### wlan.antenna\(\[antenna\]\) Get or set the antenna type \(external or internal\). -#### wlan.mac\([mac, mode]\) +### wlan.mac\(\[mac, mode\]\) when no arguments are passed a 6-byte long `bytes` tuple object with the WiFI MAC address of both Wifi Station mode and Acces Point mode -``mac``: a 6 bytes bytearray mac address +`mac`: a 6 bytes bytearray mac address -``mode``: The Interface to set the given MAC address to `WLAN.STA` or `WLAN.AP` +`mode`: The Interface to set the given MAC address to `WLAN.STA` or `WLAN.AP` Ex: To set the mac address of Wifi Station mode: @@ -221,25 +205,25 @@ Ex: To set the mac address of Wifi Station mode: wlan.mac(bytearray([0xAE, 0x77, 0x88, 0x99, 0x22, 0x44]), WLAN.STA) ``` -_Note: STA and AP cannot have the Same Mac Address_ +_Note: STA and AP cannot have the Same Mac Address_ -#### wlan.bandwidth\(\) +### wlan.bandwidth\(\) Set the bandwidth of the wifi, either 20 MHz or 40 MHz can be configured, use constants `HT20` or `HT40` -#### wlan.hostname\(\) +### wlan.hostname\(\) Set the Host name of the device connecting to the AP in case of Wifi `mode=WLAN.STA`, in case of `mode=WLAN.AP` this is the name of the host hosting the AP. Max length of name string is 32 Bytes -#### wlan.ap\_sta\_list() +### wlan.ap\_sta\_list\(\) Gets an info list of all stations connected to the board's AP. -Info returned is a list of tuples containning ([mac address of connected STA], [average rssi value], [Wlan protocol enabled by STA]). +Info returned is a list of tuples containning \(\[mac address of connected STA\], \[average rssi value\], \[Wlan protocol enabled by STA\]\). Protocol types are either : `WLAN.PHY_11_B`, `WLAN.PHY_11_G`, `WLAN.PHY_11_N` or `WLAN.PHY_LOW_RATE` -#### wlan.max\_tx\_power([power]) +### wlan.max\_tx\_power\(\[power\]\) Gets or Sets the maximum allowable transmission power for wifi. @@ -247,51 +231,46 @@ Packets of different rates are transmitted in different powers according to the Values passed in power are mapped to transmit power levels as follows: -- \[78, 127\]: level0 -- \[76, 77\]: level1 -- \[74, 75\]: level2 -- \[68, 73\]: level3 -- \[60, 67\]: level4 -- \[52, 59\]: level5 -- \[44, 51\]: level5 - 2dBm -- \[34, 43\]: level5 - 4.5dBm -- \[28, 33\]: level5 - 6dBm -- \[20, 27\]: level5 - 8dBm -- \[8, 19\]: level5 - 11dBm -- \[-128, 7\]: level5 - 14dBm +* \[78, 127\]: level0 +* \[76, 77\]: level1 +* \[74, 75\]: level2 +* \[68, 73\]: level3 +* \[60, 67\]: level4 +* \[52, 59\]: level5 +* \[44, 51\]: level5 - 2dBm +* \[34, 43\]: level5 - 4.5dBm +* \[28, 33\]: level5 - 6dBm +* \[20, 27\]: level5 - 8dBm +* \[8, 19\]: level5 - 11dBm +* \[-128, 7\]: level5 - 14dBm -#### wlan.country([country, schan, nchan, max\_tx\_pwr, policy]) +### wlan.country\(\[country, schan, nchan, max\_tx\_pwr, policy\]\) Gets or set s Country configuration parameters for wifi. -- ``country`` That is the country name code , it is max 2 characters string representing the country eg: "CN" for china nad "NL" for Netherlands +* `country` That is the country name code , it is max 2 characters string representing the country eg: "CN" for china nad "NL" for Netherlands +* `scahn` is the start channel number, in scan process scanning will be performed starting from this channels till the total number of channels. it should be less than or equal 14. +* `nchan` is the total number of channels in the specified country. maximum is 14 +* `max_tx_pwr` Maximum transmission power allowed. see `WLAN.max_tx_power()` for more details. +* `policy` Is the method when setting country configuration for `WLAN.COUNTRY_POL_AUTO` in STA mode the wifi will aquire the same country config of the connected AP, for `WLAN.COUNTRY_POL_MAN` the configured country parameters will take effect regardless of Connected AP. -- ``scahn`` is the start channel number, in scan process scanning will be performed starting from this channels till the total number of channels. it should be less than or equal 14. +### wlan.joined\_ap\_info\(\) -- ``nchan`` is the total number of channels in the specified country. maximum is 14 +Returns a tuple with \(bssid, ssid, primary channel, rssi, Authorization method, wifi standard used\) of the connected AP in case of STA mode. -- ``max_tx_pwr`` Maximum transmission power allowed. see `WLAN.max_tx_power()` for more details. - -- ``policy`` Is the method when setting country configuration for `WLAN.COUNTRY_POL_AUTO` in STA mode the wifi will aquire the same country config of the connected AP, for `WLAN.COUNTRY_POL_MAN` the configured country parameters will take effect regardless of Connected AP. - -#### wlan.joined\_ap\_info() - -Returns a tuple with (bssid, ssid, primary channel, rssi, Authorization method, wifi standard used) of the connected AP in case of STA mode. - -#### wlan.wifi_protocol([(bool PHY11__B, bool PHY11\_G, bool PHY11\_N)]) +### wlan.wifi\_protocol\(\[\(bool PHY11\_\_B, bool PHY11\_G, bool PHY11\_N\)\]\) Sets or gets Wifi Protocol supported. -#### wlan.send\_raw(Buffer, interface=STA, use_sys_seq=True) +### wlan.send\_raw\(Buffer, interface=STA, use\_sys\_seq=True\) Send raw data through the Wifi Interface. -``Buffer``: Buffer of bytes object Containning Data to be transmitted. Data should not be greater than 1500 nor smaller than 24. +`Buffer`: Buffer of bytes object Containning Data to be transmitted. Data should not be greater than 1500 nor smaller than 24. -``interface``: The Interface to use for transmitting Data AP or STA in case the mode used is APSTA. other wise the interface currently active will be used. - -``use_sys_seq``: `True` to use the systems next sequance number for sending the data, `False` for keeping the sequance number in the given raw data buffer unchanged. +`interface`: The Interface to use for transmitting Data AP or STA in case the mode used is APSTA. other wise the interface currently active will be used. +`use_sys_seq`: `True` to use the systems next sequance number for sending the data, `False` for keeping the sequance number in the given raw data buffer unchanged. ## Constants @@ -299,12 +278,8 @@ Send raw data through the Wifi Interface. * WLAN network security: `WLAN.WEP`, `WLAN.WPA`, `WLAN.WPA2`, `WLAN.WPA2_ENT` * Antenna type: `WLAN.INT_ANT`, `WLAN.EXT_ANT` * WLAN Bandwidth: `WLAN.HT20`, `WLAN.HT40` - * WLAN protocol: `WLAN.PHY_11_B`, `WLAN.PHY_11_G`, `WLAN.PHY_11_N`, `WLAN.PHY_LOW_RATE` - * Scan Type: `WLAN.SCAN_ACTIVE` `WLAN.SCAN_PASSIVE` - - * WLAN country config policy: `WLAN.COUNTRY_POL_AUTO`, `WLAN.COUNTRY_POL_MAN` * Secondary Channel position: `WLAN.SEC_CHN_POS_ABOVE`, `WLAN.SEC_CHN_POS_BELOW` diff --git a/firmwareapi/pycom/pycom.md b/firmware-and-api-reference/pycom/pycom.md similarity index 100% rename from firmwareapi/pycom/pycom.md rename to firmware-and-api-reference/pycom/pycom.md diff --git a/gettingstarted/connection/README.md b/getting-started/connection/README.md similarity index 100% rename from gettingstarted/connection/README.md rename to getting-started/connection/README.md diff --git a/gettingstarted/connection/fipy.md b/getting-started/connection/fipy.md similarity index 96% rename from gettingstarted/connection/fipy.md rename to getting-started/connection/fipy.md index 8c24c2f..27cc16c 100644 --- a/gettingstarted/connection/fipy.md +++ b/getting-started/connection/fipy.md @@ -13,7 +13,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem. * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. @@ -23,7 +23,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the FiPy module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqVauBuoNMgcByrNql%2FPysense_FiPy.png?generation=1534772069160637&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqVdDdxkK38AlRxtkc%2FPytrack_FiPy.png?generation=1534772071490748&alt=media) @@ -96,11 +96,11 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **m ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_fipy.png) -### SIM card {#sim-card} +### SIM card If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you will need to insert a SIM card into your FiPy. It should be noted that the FiPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM. diff --git a/gettingstarted/connection/gpy.md b/getting-started/connection/gpy.md similarity index 95% rename from gettingstarted/connection/gpy.md rename to getting-started/connection/gpy.md index 2263bd6..3311f2c 100644 --- a/gettingstarted/connection/gpy.md +++ b/getting-started/connection/gpy.md @@ -12,7 +12,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. * Insert the GPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -21,7 +21,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the GPy module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqejpmTIS1tbGw0Vrl%2FPysense_GPy.png?generation=1534772072781141&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqekpWIfccll6qkt85%2FPytrack_GPy.png?generation=1534772080535030&alt=media) @@ -75,11 +75,11 @@ If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **mu ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the GPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the GPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_gpy.png) -### SIM card {#sim-card} +### SIM card If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you will need to insert a SIM card into your GPy. It should be noted that the GPy does not support regular LTE connectivity and you may require a special SIM. It is best to contact your local cellular providers for more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM. diff --git a/gettingstarted/connection/lopy.md b/getting-started/connection/lopy.md similarity index 95% rename from gettingstarted/connection/lopy.md rename to getting-started/connection/lopy.md index 5e6cd79..257047b 100644 --- a/gettingstarted/connection/lopy.md +++ b/getting-started/connection/lopy.md @@ -1,6 +1,6 @@ # LoPy -## Basic connection {#basic-connection} +## Basic connection {% tabs %} {% tab title="Exp Board 2.0" %} @@ -12,7 +12,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. * Insert the LoPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -21,7 +21,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the LoPy module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -86,7 +86,7 @@ The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 4 ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the LoPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_lopy.png) diff --git a/gettingstarted/connection/lopy4.md b/getting-started/connection/lopy4.md similarity index 95% rename from gettingstarted/connection/lopy4.md rename to getting-started/connection/lopy4.md index d605442..980e4f2 100644 --- a/gettingstarted/connection/lopy4.md +++ b/getting-started/connection/lopy4.md @@ -12,7 +12,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. * Insert the LoPy4 module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -21,7 +21,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the LoPy4 module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqbk7blltxqNtvQzH_%2FPysense_LoPy4.png?generation=1534772087747503&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqblUw130dL1aMAkLT%2FPytrack_LoPy4.png?generation=1534772079835788&alt=media) @@ -80,7 +80,7 @@ If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** co ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the LoPy4, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy4 in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the LoPy4, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the LoPy4 in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_lopy4.png) diff --git a/gettingstarted/connection/sipy.md b/getting-started/connection/sipy.md similarity index 95% rename from gettingstarted/connection/sipy.md rename to getting-started/connection/sipy.md index 5ea83e3..72549fa 100644 --- a/gettingstarted/connection/sipy.md +++ b/getting-started/connection/sipy.md @@ -12,7 +12,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. * Insert the SiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -21,7 +21,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the SiPy module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqd_e51Wyuw40k6yJv%2FPysense_SiPy.png?generation=1534772077104600&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqdauW7rAnQlc-AL07%2FPytrack_SiPy.png?generation=1534772072530754&alt=media) @@ -80,7 +80,7 @@ If you intend on using the Sigfox connectivity of the SiPy you **must** connect ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the FiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the FiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_sipy.png) diff --git a/gettingstarted/connection/wipy.md b/getting-started/connection/wipy.md similarity index 95% rename from gettingstarted/connection/wipy.md rename to getting-started/connection/wipy.md index ea60d46..f9a24b2 100644 --- a/gettingstarted/connection/wipy.md +++ b/getting-started/connection/wipy.md @@ -12,7 +12,7 @@ {% endtab %} {% tab title="Exp Board 3.0" %} -* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the expansion board. * Insert the WiPy module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. @@ -21,7 +21,7 @@ {% endtab %} {% tab title="Pytrack/Pysense/Pyscan" %} -* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). * Look for the reset button on the WiPy module \(located at a corner of the board, next to the LED\). * Locate the USB connector on the Pysense/Pytrack/Pyscan. * Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible. ![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqfutE_BZ6gjVdmiv0%2FPysense_WiPy.png?generation=1534772071067482&alt=media)![](https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LIfiUlGe6_zTmmvcuEa%2F-LKMXk1KQvBgjpw04I3u%2F-LIqfvoSjvxTIwgw2MSg%2FPytrack_WiPy.png?generation=1534772075484372&alt=media) @@ -65,7 +65,7 @@ Please ensure you have the signal level of the UART adapter set to `3.3v` before ### WiFi/Bluetooth \(optional\) -All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.](../../firmwareapi/pycom/network/wlan.md) +All Pycom modules, including the WiPy, come with a on-board WiFi antenna as well as a U.FL connector for an external antenna. The external antenna is optional and only required if you need better performance or are mounting the WiPy in such a way that the WiFi signal is blocked. Switching between the antennas is done via software, instructions for this can be found [here.]() ![](../../.gitbook/assets/wifi_pigtail_ant_wipy.png) diff --git a/gettingstarted/installation/README.md b/getting-started/installation/README.md similarity index 100% rename from gettingstarted/installation/README.md rename to getting-started/installation/README.md diff --git a/gettingstarted/installation/drivers.md b/getting-started/installation/drivers.md similarity index 100% rename from gettingstarted/installation/drivers.md rename to getting-started/installation/drivers.md diff --git a/gettingstarted/installation/firmwaretool.md b/getting-started/installation/firmwaretool.md similarity index 95% rename from gettingstarted/installation/firmwaretool.md rename to getting-started/installation/firmwaretool.md index adaaaf1..eaea79a 100644 --- a/gettingstarted/installation/firmwaretool.md +++ b/getting-started/installation/firmwaretool.md @@ -9,7 +9,7 @@ Here are the download links to the update tool. Please download the appropriate * [Linux](https://software.pycom.io/findupgrade?product=pycom-firmware-updater&type=all&platform=unix&redirect=true) \(requires `dialog` and `python-serial` package\) {% hint style="info" %} -Previous versions of firmware are available for download [**here**](../../advance/downgrade.md). +Previous versions of firmware are available for download [**here**](../../advanced-topics/downgrade.md). {% endhint %} ## Updating Device Firmware @@ -40,7 +40,7 @@ If you are having any issues, make sure the **TX and RX jumpers** are present on When using a Pysense/Pytrack/Pyscan/Expansion Board 3.0 to update your module you are not required to make a connection between `G23` and `GND`, the Pysense/Pytrack/Pyscan/Expansion Board 3.0 will do this automatically. {% endhint %} -1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md). +1. Before connecting your module to a Pysense/Pytrack board, you should update the firmware on the Pysense/Pytrack. Instructions on how to do this can be found [here](../../pytrack-pysense-pyscan/installation/firmware.md). 2. Disconnect your device from your computer 3. Insert module into Expansion Board 4. Reconnect the board via USB to your computer diff --git a/gettingstarted/installation/pymakr.md b/getting-started/installation/pymakr.md similarity index 59% rename from gettingstarted/installation/pymakr.md rename to getting-started/installation/pymakr.md index 9c575af..6fe670c 100644 --- a/gettingstarted/installation/pymakr.md +++ b/getting-started/installation/pymakr.md @@ -2,11 +2,11 @@ ![](../../.gitbook/assets/pymakr-logo-1%20%281%29.png) -## Pymakr Plugins {#pymakr-plugins} +## Pymakr Plugins To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms: -{% page-ref page="../../pymakr/installation/atom.md" %} +{% page-ref page="../../pymakr-plugin/installation/atom.md" %} -{% page-ref page="../../pymakr/installation/vscode.md" %} +{% page-ref page="../../pymakr-plugin/installation/vscode.md" %} diff --git a/gettingstarted/introduction.md b/getting-started/introduction.md similarity index 100% rename from gettingstarted/introduction.md rename to getting-started/introduction.md diff --git a/gettingstarted/programming/README.md b/getting-started/programming/README.md similarity index 100% rename from gettingstarted/programming/README.md rename to getting-started/programming/README.md diff --git a/gettingstarted/programming/examples.md b/getting-started/programming/examples.md similarity index 100% rename from gettingstarted/programming/examples.md rename to getting-started/programming/examples.md diff --git a/gettingstarted/programming/first-project.md b/getting-started/programming/first-project.md similarity index 95% rename from gettingstarted/programming/first-project.md rename to getting-started/programming/first-project.md index ba5700d..c42e60c 100644 --- a/gettingstarted/programming/first-project.md +++ b/getting-started/programming/first-project.md @@ -60,11 +60,11 @@ RGB-Blink For this example, you will just need to create a `main.py` file. -Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr/settings.md). +Now that the project structure is setup, you may wish to configure project specific settings for Pymakr e.g. Which serial port to use. On Atom you need to click the `^` button on the Pymakr pane, then click `Project Settings`. On Visual Studio Code you need to click the `All commands` button on the bottom of the windows, then click `Pymakr > Project Settings`. This creates a file called `pymakr.conf` inside your project and populates it with default settings copied over from your global settings. A detailed explanation of these settings can be found [here](../../pymakr-plugin/settings.md). ## Controlling the on-board LED -Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmwareapi/introduction.md). For this example you will need to open the `main.py` file and add the following code: +Now that you have setup and configured your project, we can move on to programming your module. The first thing we will need to do is import some libraries in order to interact with the on-board LED. The Pycom firmware comes with a large amount of libraries for standard functionality built-in. You can find out more about these in the [API documentation](../../firmware-and-api-reference/introduction.md). For this example you will need to open the `main.py` file and add the following code: ```python import pycom diff --git a/gettingstarted/programming/ftp.md b/getting-started/programming/ftp.md similarity index 91% rename from gettingstarted/programming/ftp.md rename to getting-started/programming/ftp.md index 97094b5..3b01383 100644 --- a/gettingstarted/programming/ftp.md +++ b/getting-started/programming/ftp.md @@ -8,7 +8,7 @@ The file system is accessible via the native FTP server running on each Pycom de * username: `micro` * password: `python` -See [network.server](../../firmwareapi/pycom/network/server.md) for information on how to change the defaults. The recommended clients are: +See [network.server](../../firmware-and-api-reference/pycom/network/server.md) for information on how to change the defaults. The recommended clients are: * macOS/Linux: default FTP client * Windows: Filezilla and FireFTP diff --git a/gettingstarted/programming/micropython.md b/getting-started/programming/micropython.md similarity index 100% rename from gettingstarted/programming/micropython.md rename to getting-started/programming/micropython.md diff --git a/gettingstarted/programming/repl/README.md b/getting-started/programming/repl/README.md similarity index 100% rename from gettingstarted/programming/repl/README.md rename to getting-started/programming/repl/README.md diff --git a/gettingstarted/programming/repl/serial.md b/getting-started/programming/repl/serial.md similarity index 88% rename from gettingstarted/programming/repl/serial.md rename to getting-started/programming/repl/serial.md index 0a06e6b..d8fd494 100644 --- a/gettingstarted/programming/repl/serial.md +++ b/getting-started/programming/repl/serial.md @@ -6,7 +6,7 @@ In order to connect to the REPL over USB serial, there are multiple methods. Det ## All platforms -By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). +By far the easiest way to access the USB UART REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). ## macOS and Linux diff --git a/gettingstarted/programming/repl/telnet.md b/getting-started/programming/repl/telnet.md similarity index 75% rename from gettingstarted/programming/repl/telnet.md rename to getting-started/programming/repl/telnet.md index 0252655..be36720 100644 --- a/gettingstarted/programming/repl/telnet.md +++ b/getting-started/programming/repl/telnet.md @@ -1,6 +1,6 @@ # Telnet REPL -Pycom devices also support a connection via `telnet`, using the device's on board WiFi/WLAN. Connect to the device's WiFi Access Point \(AP\) and using the following credentials to connect to the AP. The WiFi `SSID` will appear upon powering on a Pycom Device for the first time \(e.g. `lopy-`\). To re-enable this feature at a later date, please see [network.WLAN](../../../firmwareapi/pycom/network/wlan.md). +Pycom devices also support a connection via `telnet`, using the device's on board WiFi/WLAN. Connect to the device's WiFi Access Point \(AP\) and using the following credentials to connect to the AP. The WiFi `SSID` will appear upon powering on a Pycom Device for the first time \(e.g. `lopy-`\). To re-enable this feature at a later date, please see [network.WLAN](). * password: `www.pycom.io` @@ -11,11 +11,11 @@ Additionally, to use the MircoPython REPL over telnet, further authentication is * username: `micro` * password: `python` -See [network.server](../../../firmwareapi/pycom/network/server.md) for info on how to change the default authentication. +See [network.server](../../../firmware-and-api-reference/pycom/network/server.md) for info on how to change the default authentication. ## All platforms -By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr/installation/). +By far the easiest way to access the Telnet REPL is via the our [Pymakr plug-in](../../../pymakr-plugin/installation/) for Atom and Visual Studio Code. This adds a pane to the bottom of the editors that allows you to directly access the REPL and any output from the device. Detailed instructions on how to setup Pymakr can be found [here](../../../pymakr-plugin/installation/). ## macOS and Linux diff --git a/gettingstarted/programming/safeboot.md b/getting-started/programming/safeboot.md similarity index 100% rename from gettingstarted/programming/safeboot.md rename to getting-started/programming/safeboot.md diff --git a/gettingstarted/registration/README.md b/getting-started/registration/README.md similarity index 100% rename from gettingstarted/registration/README.md rename to getting-started/registration/README.md diff --git a/gettingstarted/registration/cellular.md b/getting-started/registration/cellular.md similarity index 100% rename from gettingstarted/registration/cellular.md rename to getting-started/registration/cellular.md diff --git a/gettingstarted/registration/lora/README.md b/getting-started/registration/lora/README.md similarity index 91% rename from gettingstarted/registration/lora/README.md rename to getting-started/registration/lora/README.md index 74a5473..f963141 100644 --- a/gettingstarted/registration/lora/README.md +++ b/getting-started/registration/lora/README.md @@ -24,11 +24,11 @@ The output will be a hex string like: `70B3D5499585FCA1`. Once you have this you #### OTAA -If you wish to connect via OTAA \(which is the recommended method\) the network will provide you with an `Application EUI` and `Application Key`. The former identifies what application your device is connecting to, the latter is a shared secret key unique to your device to generate the session keys that prove its identity to the network. Once you have these you can use the [LoRaWAN OTAA example](../../../tutorials/lora/lorawan-otaa.md) code to connect to the network. +If you wish to connect via OTAA \(which is the recommended method\) the network will provide you with an `Application EUI` and `Application Key`. The former identifies what application your device is connecting to, the latter is a shared secret key unique to your device to generate the session keys that prove its identity to the network. Once you have these you can use the [LoRaWAN OTAA example](../../../tutorials-and-examples/lora/lorawan-otaa.md) code to connect to the network. #### ABP -With ABP the encryption keys enabling communication with the network are preconfigured in the device. The network will need to provide you with a `Device Address`, `Network Session Key` and `Application Session Key`. Once you have these you can use the [LoRaWAN ABP example](../../../tutorials/lora/lorawan-abp.md) code to connect to the network. +With ABP the encryption keys enabling communication with the network are preconfigured in the device. The network will need to provide you with a `Device Address`, `Network Session Key` and `Application Session Key`. Once you have these you can use the [LoRaWAN ABP example](../../../tutorials-and-examples/lora/lorawan-abp.md) code to connect to the network. ### Networks diff --git a/gettingstarted/registration/lora/objenious.md b/getting-started/registration/lora/objenious.md similarity index 100% rename from gettingstarted/registration/lora/objenious.md rename to getting-started/registration/lora/objenious.md diff --git a/gettingstarted/registration/lora/ttn.md b/getting-started/registration/lora/ttn.md similarity index 98% rename from gettingstarted/registration/lora/ttn.md rename to getting-started/registration/lora/ttn.md index c11198a..18e1271 100644 --- a/gettingstarted/registration/lora/ttn.md +++ b/getting-started/registration/lora/ttn.md @@ -38,7 +38,7 @@ Once the device has been added, change the `Activation Method` between `OTAA` an ## Register a Nano-Gateway -You can also setup your Pycom module to act as a gateway with The Things Network. The code required to do this can be found [here](../../../tutorials/lora/lorawan-nano-gateway.md). +You can also setup your Pycom module to act as a gateway with The Things Network. The code required to do this can be found [here](../../../tutorials-and-examples/lora/lorawan-nano-gateway.md). Inside the TTN Console, there are two options, `Applications` and `Gateways`. Select `Gateways` and then click on `register Gateway`. This will allow for the set up and registration of a new nano-gateway. diff --git a/gettingstarted/registration/sigfox.md b/getting-started/registration/sigfox.md similarity index 100% rename from gettingstarted/registration/sigfox.md rename to getting-started/registration/sigfox.md diff --git a/datasheets/boards/README.md b/product-info/boards/README.md similarity index 100% rename from datasheets/boards/README.md rename to product-info/boards/README.md diff --git a/datasheets/boards/deepsleep/README.md b/product-info/boards/deepsleep/README.md similarity index 100% rename from datasheets/boards/deepsleep/README.md rename to product-info/boards/deepsleep/README.md diff --git a/datasheets/boards/deepsleep/api.md b/product-info/boards/deepsleep/api.md similarity index 100% rename from datasheets/boards/deepsleep/api.md rename to product-info/boards/deepsleep/api.md diff --git a/datasheets/boards/expansion2.md b/product-info/boards/expansion2.md similarity index 100% rename from datasheets/boards/expansion2.md rename to product-info/boards/expansion2.md diff --git a/datasheets/boards/expansion3.md b/product-info/boards/expansion3.md similarity index 95% rename from datasheets/boards/expansion3.md rename to product-info/boards/expansion3.md index 8297d3b..918eefa 100644 --- a/datasheets/boards/expansion3.md +++ b/product-info/boards/expansion3.md @@ -40,5 +40,5 @@ The specsheet of the Expansion Board is available as a PDF File. ## Troubleshooting -* If PIC stays in bootloader mode, the [`dfu-util` update](../../pytrackpysense/installation/firmware.md) should be performed +* If PIC stays in bootloader mode, the [`dfu-util` update](../../pytrack-pysense-pyscan/installation/firmware.md) should be performed diff --git a/datasheets/boards/pyscan.md b/product-info/boards/pyscan.md similarity index 92% rename from datasheets/boards/pyscan.md rename to product-info/boards/pyscan.md index f12e700..074b29e 100644 --- a/datasheets/boards/pyscan.md +++ b/product-info/boards/pyscan.md @@ -21,7 +21,7 @@ Libraries for the rest of the components will be added soon. ## Driver -The Windows 7 driver for Pyscan is located [here](../../pytrackpysense/installation/firmware.md). +The Windows 7 driver for Pyscan is located [here](../../pytrack-pysense-pyscan/installation/firmware.md). For other Operating Systems there's no driver required. diff --git a/datasheets/boards/pysense.md b/product-info/boards/pysense.md similarity index 100% rename from datasheets/boards/pysense.md rename to product-info/boards/pysense.md diff --git a/datasheets/boards/pytrack.md b/product-info/boards/pytrack.md similarity index 100% rename from datasheets/boards/pytrack.md rename to product-info/boards/pytrack.md diff --git a/datasheets/development/README.md b/product-info/development/README.md similarity index 100% rename from datasheets/development/README.md rename to product-info/development/README.md diff --git a/datasheets/development/fipy.md b/product-info/development/fipy.md similarity index 72% rename from datasheets/development/fipy.md rename to product-info/development/fipy.md index b8d3ecf..cad6b2f 100644 --- a/datasheets/development/fipy.md +++ b/product-info/development/fipy.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/fipy) -**Getting Started:** [Click Here](../../gettingstarted/connection/fipy.md) +**Getting Started:** [Click Here](../../getting-started/connection/fipy.md) ## Pinout @@ -48,13 +48,13 @@ The AT commands for the Sequans Monarch modem on the FiPy are available in a PDF ## Tutorials -Tutorials on how to the FiPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: +Tutorials on how to the FiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the FiPy: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials/sigfox.md) -* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) -* [NB-IoT](../../tutorials/lte/nb-iot.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials-and-examples/sigfox.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/gpy.md b/product-info/development/gpy.md similarity index 79% rename from datasheets/development/gpy.md rename to product-info/development/gpy.md index aa09c18..ad8bb14 100644 --- a/datasheets/development/gpy.md +++ b/product-info/development/gpy.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/gpy) -**Getting Started:** [Click Here](../../gettingstarted/connection/gpy.md) +**Getting Started:** [Click Here](../../getting-started/connection/gpy.md) ## Pinout @@ -48,10 +48,10 @@ The AT commands for the Sequans Monarch modem on the GPy are available in a PDF ## Tutorials -Tutorials on how to the GPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the GPy: +Tutorials on how to the GPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the GPy: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) -* [NB-IoT](../../tutorials/lte/nb-iot.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/lopy.md b/product-info/development/lopy.md similarity index 82% rename from datasheets/development/lopy.md rename to product-info/development/lopy.md index 8d3cbcb..5fa3d7f 100644 --- a/datasheets/development/lopy.md +++ b/product-info/development/lopy.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/lopy) -**Getting Started:** [Click Here](../../gettingstarted/connection/lopy.md) +**Getting Started:** [Click Here](../../getting-started/connection/lopy.md) ## Pinout @@ -40,10 +40,10 @@ Due to a couple issues with the LoPy design the module draws more current than i ## Tutorials -Tutorials on how to the LoPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: +Tutorials on how to the LoPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/lopy4.md b/product-info/development/lopy4.md similarity index 71% rename from datasheets/development/lopy4.md rename to product-info/development/lopy4.md index 46bfb7d..53802c8 100644 --- a/datasheets/development/lopy4.md +++ b/product-info/development/lopy4.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/lopy4) -**Getting Started:** [Click Here](../../gettingstarted/connection/lopy4.md) +**Getting Started:** [Click Here](../../getting-started/connection/lopy4.md) ## Pinout @@ -38,11 +38,11 @@ The `Vin` pin on the LoPy4 can be supplied with a voltage ranging from `3.5v` to ## Tutorials -Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: +Tutorials on how to the LoPy4 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the LoPy4: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials/sigfox.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials-and-examples/sigfox.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/sipy.md b/product-info/development/sipy.md similarity index 85% rename from datasheets/development/sipy.md rename to product-info/development/sipy.md index c9817a7..fd75f9e 100644 --- a/datasheets/development/sipy.md +++ b/product-info/development/sipy.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/sipy) -**Getting Started:** [Click Here](../../gettingstarted/connection/sipy.md) +**Getting Started:** [Click Here](../../getting-started/connection/sipy.md) ## Pinout @@ -40,9 +40,9 @@ Due to a couple issues with the SiPy design the module draws more current than i ## Tutorials -Tutorials on how to the SiPy module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: +Tutorials on how to the SiPy module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the SiPy: -* [WiFi connection](../../tutorials/all/wlan.md) -* [Sigfox](../../tutorials/sigfox.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [Sigfox](../../tutorials-and-examples/sigfox.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/wipy2.md b/product-info/development/wipy2.md similarity index 87% rename from datasheets/development/wipy2.md rename to product-info/development/wipy2.md index e818e05..3fed134 100644 --- a/datasheets/development/wipy2.md +++ b/product-info/development/wipy2.md @@ -4,7 +4,7 @@ **Store**: Discontinued, See [WiPy3](wipy3.md) -**Getting Started:** [Click Here](../../gettingstarted/connection/wipy.md) +**Getting Started:** [Click Here](../../getting-started/connection/wipy.md) ## Pinout @@ -40,8 +40,8 @@ Due to a couple issues with the WiPy2 design the module draws more current than ## Tutorials -Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: +Tutorials on how to the WiPy2 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy2: -* [WiFi connection](../../tutorials/all/wlan.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/development/wipy3.md b/product-info/development/wipy3.md similarity index 82% rename from datasheets/development/wipy3.md rename to product-info/development/wipy3.md index aad4d97..c35a1f7 100644 --- a/datasheets/development/wipy3.md +++ b/product-info/development/wipy3.md @@ -4,7 +4,7 @@ **Store**: [Buy Here](http://www.pycom.io/wipy-3) -**Getting Started:** [Click Here](../../gettingstarted/connection/wipy.md) +**Getting Started:** [Click Here](../../getting-started/connection/wipy.md) ## Pinout @@ -45,8 +45,8 @@ The `Vin` pin on the WiPy3 can be supplied with a voltage ranging from `3.5v` to ## Tutorials -Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: +Tutorials on how to the WiPy3 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the WiPy3: -* [WiFi connection](../../tutorials/all/wlan.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/introduction.md b/product-info/introduction.md similarity index 100% rename from datasheets/introduction.md rename to product-info/introduction.md diff --git a/datasheets/notes.md b/product-info/notes.md similarity index 100% rename from datasheets/notes.md rename to product-info/notes.md diff --git a/datasheets/oem/README.md b/product-info/oem/README.md similarity index 100% rename from datasheets/oem/README.md rename to product-info/oem/README.md diff --git a/datasheets/oem/g01.md b/product-info/oem/g01.md similarity index 73% rename from datasheets/oem/g01.md rename to product-info/oem/g01.md index e7b1154..7d64d47 100644 --- a/datasheets/oem/g01.md +++ b/product-info/oem/g01.md @@ -34,10 +34,10 @@ The AT commands for the Sequans Monarch modem on the G01 are available in a PDF ## Tutorials -Tutorials on how to the G01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the G01: +Tutorials on how to the G01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the G01: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LTE CAT-M1](../../tutorials/lte/cat-m1.md) -* [NB-IoT](../../tutorials/lte/nb-iot.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LTE CAT-M1](../../tutorials-and-examples/lte/cat-m1.md) +* [NB-IoT](../../tutorials-and-examples/lte/nb-iot.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/oem/l01.md b/product-info/oem/l01.md similarity index 66% rename from datasheets/oem/l01.md rename to product-info/oem/l01.md index b05797b..1ba0003 100644 --- a/datasheets/oem/l01.md +++ b/product-info/oem/l01.md @@ -28,10 +28,10 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the L01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L01: +Tutorials on how to the L01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L01: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/oem/l01_reference.md b/product-info/oem/l01_reference.md similarity index 100% rename from datasheets/oem/l01_reference.md rename to product-info/oem/l01_reference.md diff --git a/datasheets/oem/l04.md b/product-info/oem/l04.md similarity index 63% rename from datasheets/oem/l04.md rename to product-info/oem/l04.md index 6327180..6013844 100644 --- a/datasheets/oem/l04.md +++ b/product-info/oem/l04.md @@ -28,11 +28,11 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the L04 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L04: +Tutorials on how to the L04 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the L04: -* [WiFi connection](../../tutorials/all/wlan.md) -* [LoRaWAN node](../../tutorials/lora/lorawan-abp.md) -* [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md) -* [Sigfox](../../tutorials/sigfox.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [LoRaWAN node](../../tutorials-and-examples/lora/lorawan-abp.md) +* [LoRaWAN nano gateway](../../tutorials-and-examples/lora/lorawan-nano-gateway.md) +* [Sigfox](../../tutorials-and-examples/sigfox.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/datasheets/oem/universal_reference.md b/product-info/oem/universal_reference.md similarity index 100% rename from datasheets/oem/universal_reference.md rename to product-info/oem/universal_reference.md diff --git a/datasheets/oem/w01.md b/product-info/oem/w01.md similarity index 75% rename from datasheets/oem/w01.md rename to product-info/oem/w01.md index f83cb48..6548e2d 100644 --- a/datasheets/oem/w01.md +++ b/product-info/oem/w01.md @@ -28,8 +28,8 @@ Please note that the PIN assignments for UART1 \(TX1/RX1\), SPI \(CLK, MOSI, MIS ## Tutorials -Tutorials on how to the W01 module can be found in the [examples](../../tutorials/introduction.md) section of this documentation. The following tutorials might be of specific interest for the W01: +Tutorials on how to the W01 module can be found in the [examples](../../tutorials-and-examples/introduction.md) section of this documentation. The following tutorials might be of specific interest for the W01: -* [WiFi connection](../../tutorials/all/wlan.md) -* [BLE](../../tutorials/all/ble.md) +* [WiFi connection](../../tutorials-and-examples/all/wlan.md) +* [BLE](../../tutorials-and-examples/all/ble.md) diff --git a/products.md b/products.md index f69407c..92ef2d4 100644 --- a/products.md +++ b/products.md @@ -8,32 +8,103 @@ Below you will find tables of all Pycom products. These tables illustrate the fu | Module | WiFi | Bluetooth | LoRa | Sigfox | LTE CAT-M1NB-IoT | | :--- | :--- | :--- | :--- | :--- | :--- | -| [ WiPy 3.0](datasheets/development/wipy3.md) | ✔ | ✔ | | | | -| [SiPy](datasheets/development/sipy.md) | ✔ | ✔ | | ✔ | | -| [GPy](datasheets/development/gpy.md) | ✔ | ✔ | | | ✔ | -| [LoPy](datasheets/development/lopy.md) | ✔ | ✔ | ✔ | | | -| [LoPy4](datasheets/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | -| [FiPy](datasheets/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | +| [ WiPy 3.0](product-info/development/wipy3.md) | ✔ | ✔ | | | | +| [SiPy](product-info/development/sipy.md) | ✔ | ✔ | | ✔ | | +| [GPy](product-info/development/gpy.md) | ✔ | ✔ | | | ✔ | +| [LoPy](product-info/development/lopy.md) | ✔ | ✔ | ✔ | | | +| [LoPy4](product-info/development/lopy4.md) | ✔ | ✔ | ✔ | ✔ | | +| [FiPy](product-info/development/fipy.md) | ✔ | ✔ | ✔ | ✔ | ✔ | | Antennas | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [External WiFi/BT Antenna Kit](https://pycom.io/product/external-wifi-antenna/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LoRa & Sigfox Antenna Kit](https://pycom.io/product/lora-antenna-kit/) | [LTE-M Antenna Kit](https://pycom.io/product/lte-m-antenna-kit/) | ## Accessories -| Accessory | [Expansion Board](datasheets/boards/expansion3.md) | [Pysense](datasheets/boards/pysense.md) | [Pytrack](datasheets/boards/pytrack.md) | [Pyscan](datasheets/boards/pyscan.md) | -| :--- | :--- | :--- | :--- | :--- | -| [PyCase](https://pycom.io/product/pycase/) | ✔ | | | | -| [IP67 Case for Expansion Board](https://pycom.io/product/ip67-expansion-board-case/) | ✔ | | | | -| [IP67 Case for Pysense/Pytrack/Pyscan](https://pycom.io/product/ip67-case/) | | ✔ | ✔ | ✔ | -| [IP67 Case \(universal\)](https://pycom.io/product/universal-ip67-case/) | ✔ | ✔ | ✔ | ✔ | -| LiPo Battery \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | -| Micro USB Cable Required \(user-supplied\) | ✔ | ✔ | ✔ | ✔ | -| Pyscan Modules[OLED Module](https://pycom.io/product/oled-screen/)[2MP Camera](https://pycom.io/product/2mp-camera/)[Barcode Reader](https://pycom.io/product/barcode-reader)[Fingerprint Scanner](https://pycom.io/product/fingerprint-scanner/)[IR Image Sensor](https://pycom.io/product/infared-image-sensor/) | | | | ✔ | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AccessoryExpansion Board + Pysense + Pytrack + Pyscan +
PyCase + ✔
IP67 Case for Expansion Board + ✔
IP67 Case for Pysense/Pytrack/Pyscan + ✔✔✔
IP67 Case (universal) + ✔✔✔✔
LiPo Battery (user-supplied)✔✔✔✔
Micro USB Cable Required (user-supplied)✔✔✔✔
+

Pyscan Modules

+

OLED Module +

+

2MP Camera +

+

Barcode Reader +

+

Fingerprint Scanner +

+

IR Image Sensor +

+ 		✔
## OEM Modules -## OEM Modules - -| OEM Module | [L01/W01 Reference Board](datasheets/oem/l01_reference.md) | [Universal Reference Board](datasheets/oem/universal_reference.md) | +| OEM Module | [L01/W01 Reference Board](product-info/oem/l01_reference.md) | [Universal Reference Board](product-info/oem/universal_reference.md) | | :--- | :--- | :--- | -| [W01](datasheets/oem/w01.md) | ✔ | ✔ | -| [L01](datasheets/oem/l01.md) | ✔ | ✔ | -| [L04](datasheets/oem/l04.md) | | ✔ | -| [G01](datasheets/oem/g01.md) | | ✔ | +| [W01](product-info/oem/w01.md) | ✔ | ✔ | +| [L01](product-info/oem/l01.md) | ✔ | ✔ | +| [L04](product-info/oem/l04.md) | | ✔ | +| [G01](product-info/oem/g01.md) | | ✔ | diff --git a/pybytes/connect/flash.md b/pybytes/connect/flash.md index f1b5b2d..3970beb 100644 --- a/pybytes/connect/flash.md +++ b/pybytes/connect/flash.md @@ -31,7 +31,7 @@ You can also download _Pybytes library_ at the device's settings page: ### Step 2. Flash your device with Pymakr {% hint style="info" %} -In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr/installation/atom.md). +In case you haven't installed Pymakr plugin, follow [these instructions](../../pymakr-plugin/installation/atom.md). {% endhint %} 1. Connect your device to your computer with USB cable. @@ -52,7 +52,7 @@ In case you haven't installed Pymakr plugin, follow [these instructions](../../p Like deviceToken or WiFi credentials. You can change e.g. your WiFy password here. -6. Put your device in [safe boot mode](../../gettingstarted/programming/safeboot.md). +6. Put your device in [safe boot mode](../../getting-started/programming/safeboot.md). 7. Upload code to your device by clicking on _Upload_ button in Pymakr. After all Pybytes library files are uploaded to device, device will restart and will connect to Pybytes. diff --git a/pybytes/connect/sigfox/README.md b/pybytes/connect/sigfox/README.md index b6c1eeb..1f2078d 100644 --- a/pybytes/connect/sigfox/README.md +++ b/pybytes/connect/sigfox/README.md @@ -1,7 +1,7 @@ # Add Sigfox device {% hint style="danger" %} -Before you start you need to create Sigfox account. You need Pycom device with Sigfox to get your Sigfox account. [**Follow these instructions**](../../../gettingstarted/registration/sigfox.md). +Before you start you need to create Sigfox account. You need Pycom device with Sigfox to get your Sigfox account. [**Follow these instructions**](../../../getting-started/registration/sigfox.md). {% endhint %} ## Create Sigfox API credentials diff --git a/pybytes/connect/sigfox/custom.md b/pybytes/connect/sigfox/custom.md index d0abe06..fb072a5 100644 --- a/pybytes/connect/sigfox/custom.md +++ b/pybytes/connect/sigfox/custom.md @@ -33,5 +33,5 @@ After your device was flashed with Pybytes firmware in automatically start addin ## Troubleshooting -[Disengage Sigfox sequence number](../../../tutorials/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) diff --git a/pybytes/connect/sigfox/devkit.md b/pybytes/connect/sigfox/devkit.md index 3323200..6040f49 100644 --- a/pybytes/connect/sigfox/devkit.md +++ b/pybytes/connect/sigfox/devkit.md @@ -2,7 +2,7 @@ Every Sigfox Pycom device comes with free Sigfox connectivity - Sigfox DevKit contract. It provides one year of Sigfox connectivity. This is great for prototyping. -But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](../../../gettingstarted/registration/sigfox.md). +But every device you want to add to Pybytes you need register on Sigfox backend. You need to repeat [Sigfox activation procedure](../../../getting-started/registration/sigfox.md). After you add your Sigfox credentials to Pybytes you can see DevKit contract type is selected as default \(on page Settings → Sigfox API\). @@ -41,5 +41,5 @@ This is not an issue with Custom contract, where _device type_ on Sigfox backend ## Troubleshooting -[Disengage Sigfox sequence number](../../../tutorials/sigfox.md#disengage-sequence-number) +[Disengage Sigfox sequence number](../../../tutorials-and-examples/sigfox.md#disengage-sequence-number) diff --git a/pybytes/integrations/README.md b/pybytes/integrations/README.md index a87f4c7..eef5e3b 100644 --- a/pybytes/integrations/README.md +++ b/pybytes/integrations/README.md @@ -1,5 +1,8 @@ -# Integration with external services +# Integrations + +## Integration with external services Pybytes offers a way to interact with external IoT platform or custom services, like the following: -* [AWS IoT](aws.md): a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices +* [AWS IoT](amazon-iot.md): a managed cloud platform that lets connected devices easily and securely interact with cloud applications and other devices + diff --git a/pybytes/integrations/amazon-iot.md b/pybytes/integrations/amazon-iot.md new file mode 100644 index 0000000..483b2fd --- /dev/null +++ b/pybytes/integrations/amazon-iot.md @@ -0,0 +1,32 @@ +# Amazon IoT + +Whenever one of your integrated devices sends a message to our broker, we republish the binary payload to the endpoint specified for its integration. In order to save the data received by AWS, [you must set up a rule](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html). You can also test that everything's working with the [AWS IoT MQTT client](https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html). + +**Warning**: do not delete AWS things or groups directly from AWS user interface, otherwise the integration with Pybytes will stop working. Always use Pybytes interface to delete AWS things or groups. + +## Integrate your devices + +1. Go in the sidebar, click on _New Integration_ and then on _Amazon Web Services_ + + + + ![](../../.gitbook/assets/01_aws_integration.png) + +2. Fill in the form choosing an [AWS region](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) and your AWS credentials. You can optionally choose to save them inside the local storage for future use. Once you're done, click _Login_ + + + + ![](../../.gitbook/assets/02_aws_integration.png) + +3. In this step, you have to specify the [AWS group](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html) name \(just alphanumeric letter, dashes and underscore are allowed\), the custom topic and the devices you want to bind to AWS. When you're ready, click _Create_ + + + + ![](../../.gitbook/assets/03_aws_integration.png) + +4. If everything's worked as expected, you should be able to see a summary of your integration like the following: + + + + ![](../../.gitbook/assets/04_aws_integration.png) + diff --git a/pybytes/introduction.md b/pybytes/introduction.md index d0f8589..8e6a154 100644 --- a/pybytes/introduction.md +++ b/pybytes/introduction.md @@ -29,3 +29,4 @@ In a nutshell, Pybytes is an environment designed to optimise your IoT applicati * [Connect your Pycom module to Pybytes](connect/) * [Visualise data from your device](dashboard.md) * [Integrations with external services](integrations/) + diff --git a/pymakr/installation/README.md b/pymakr-plugin/installation/README.md similarity index 87% rename from pymakr/installation/README.md rename to pymakr-plugin/installation/README.md index bb7175f..1781c20 100644 --- a/pymakr/installation/README.md +++ b/pymakr-plugin/installation/README.md @@ -2,7 +2,7 @@ ![](../../.gitbook/assets/pymakr-logo-1.png) -## Pymakr Plugins {#pymakr-plugins} +## Pymakr Plugins To make it as easy as possible Pycom has developed a plugin for two popular text editors, called Pymakr. These plugins have been built and are available for the following platforms: diff --git a/pymakr/installation/atom.md b/pymakr-plugin/installation/atom.md similarity index 100% rename from pymakr/installation/atom.md rename to pymakr-plugin/installation/atom.md diff --git a/pymakr/installation/vscode.md b/pymakr-plugin/installation/vscode.md similarity index 100% rename from pymakr/installation/vscode.md rename to pymakr-plugin/installation/vscode.md diff --git a/pymakr/settings.md b/pymakr-plugin/settings.md similarity index 100% rename from pymakr/settings.md rename to pymakr-plugin/settings.md diff --git a/pymakr/toolsfeatures.md b/pymakr-plugin/toolsfeatures.md similarity index 100% rename from pymakr/toolsfeatures.md rename to pymakr-plugin/toolsfeatures.md diff --git a/pytrackpysense/apireference/README.md b/pytrack-pysense-pyscan/apireference/README.md similarity index 100% rename from pytrackpysense/apireference/README.md rename to pytrack-pysense-pyscan/apireference/README.md diff --git a/pytrackpysense/apireference/pyscan.md b/pytrack-pysense-pyscan/apireference/pyscan.md similarity index 100% rename from pytrackpysense/apireference/pyscan.md rename to pytrack-pysense-pyscan/apireference/pyscan.md diff --git a/pytrackpysense/apireference/pysense.md b/pytrack-pysense-pyscan/apireference/pysense.md similarity index 100% rename from pytrackpysense/apireference/pysense.md rename to pytrack-pysense-pyscan/apireference/pysense.md diff --git a/pytrackpysense/apireference/pytrack.md b/pytrack-pysense-pyscan/apireference/pytrack.md similarity index 100% rename from pytrackpysense/apireference/pytrack.md rename to pytrack-pysense-pyscan/apireference/pytrack.md diff --git a/pytrackpysense/apireference/sleep.md b/pytrack-pysense-pyscan/apireference/sleep.md similarity index 100% rename from pytrackpysense/apireference/sleep.md rename to pytrack-pysense-pyscan/apireference/sleep.md diff --git a/pytrackpysense/installation/README.md b/pytrack-pysense-pyscan/installation/README.md similarity index 100% rename from pytrackpysense/installation/README.md rename to pytrack-pysense-pyscan/installation/README.md diff --git a/pytrackpysense/installation/drivers.md b/pytrack-pysense-pyscan/installation/drivers.md similarity index 100% rename from pytrackpysense/installation/drivers.md rename to pytrack-pysense-pyscan/installation/drivers.md diff --git a/pytrackpysense/installation/firmware.md b/pytrack-pysense-pyscan/installation/firmware.md similarity index 100% rename from pytrackpysense/installation/firmware.md rename to pytrack-pysense-pyscan/installation/firmware.md diff --git a/pytrackpysense/installation/libraries.md b/pytrack-pysense-pyscan/installation/libraries.md similarity index 100% rename from pytrackpysense/installation/libraries.md rename to pytrack-pysense-pyscan/installation/libraries.md diff --git a/pytrackpysense/introduction.md b/pytrack-pysense-pyscan/introduction.md similarity index 100% rename from pytrackpysense/introduction.md rename to pytrack-pysense-pyscan/introduction.md diff --git a/tutorials/all/README.md b/tutorials-and-examples/all/README.md similarity index 100% rename from tutorials/all/README.md rename to tutorials-and-examples/all/README.md diff --git a/tutorials/all/adc.md b/tutorials-and-examples/all/adc.md similarity index 94% rename from tutorials/all/adc.md rename to tutorials-and-examples/all/adc.md index acbc3a8..8a86ac4 100644 --- a/tutorials/all/adc.md +++ b/tutorials-and-examples/all/adc.md @@ -1,6 +1,6 @@ # ADC -This example is a simple ADC sample. For more information please see [`ADC`](../../firmwareapi/pycom/machine/adc.md). +This example is a simple ADC sample. For more information please see [`ADC`](../../firmware-and-api-reference/pycom/machine/adc.md). ```python from machine import ADC diff --git a/tutorials/all/aws.md b/tutorials-and-examples/all/aws.md similarity index 100% rename from tutorials/all/aws.md rename to tutorials-and-examples/all/aws.md diff --git a/tutorials/all/ble.md b/tutorials-and-examples/all/ble.md similarity index 97% rename from tutorials/all/ble.md rename to tutorials-and-examples/all/ble.md index 26f4cea..b056ed1 100644 --- a/tutorials/all/ble.md +++ b/tutorials-and-examples/all/ble.md @@ -2,7 +2,7 @@ At present, basic BLE functionality is available. More features will be implemented in the near future, such as pairing. This page will be updated in line with these features. -Full info on `bluetooth` can be found within [Bluetooth page](../../firmwareapi/pycom/network/bluetooth/) of the Firmware API Reference. +Full info on `bluetooth` can be found within [Bluetooth page](../../firmware-and-api-reference/pycom/network/bluetooth/) of the Firmware API Reference. ## Scan for BLE Devices diff --git a/tutorials/all/https.md b/tutorials-and-examples/all/https.md similarity index 84% rename from tutorials/all/https.md rename to tutorials-and-examples/all/https.md index 417a3ed..59bcfaa 100644 --- a/tutorials/all/https.md +++ b/tutorials-and-examples/all/https.md @@ -24,5 +24,5 @@ ss = ssl.wrap_socket(s, cert_reqs=ssl.CERT_REQUIRED, ca_certs='/flash/cert/ca.pe ss.connect(socket.getaddrinfo('cloud.blynk.cc', 8441)[0][-1]) ``` -For more info, check the [`ssl`](../../firmwareapi/micropython/ussl.md) module in the API reference. +For more info, check the [`ssl`](../../firmware-and-api-reference/micropython/ussl.md) module in the API reference. diff --git a/tutorials/all/i2c.md b/tutorials-and-examples/all/i2c.md similarity index 100% rename from tutorials/all/i2c.md rename to tutorials-and-examples/all/i2c.md diff --git a/tutorials/all/modbus.md b/tutorials-and-examples/all/modbus.md similarity index 100% rename from tutorials/all/modbus.md rename to tutorials-and-examples/all/modbus.md diff --git a/tutorials/all/mqtt.md b/tutorials-and-examples/all/mqtt.md similarity index 100% rename from tutorials/all/mqtt.md rename to tutorials-and-examples/all/mqtt.md diff --git a/tutorials/all/ota.md b/tutorials-and-examples/all/ota.md similarity index 96% rename from tutorials/all/ota.md rename to tutorials-and-examples/all/ota.md index 9ee71c7..9e353c4 100644 --- a/tutorials/all/ota.md +++ b/tutorials-and-examples/all/ota.md @@ -2,7 +2,7 @@ ## Overview -Pycom modules come with the ability to update the devices firmware, while it is still running, we call this an "over the air" \(OTA\) update. The [`pycom`](../../firmwareapi/pycom/pycom.md) library provides several functions to achieve this. This example will demonstrate how you could potentially use this functionality to update deployed devices. The full source code of this example can be found [here](https://github.com/pycom/pycom-libraries/tree/master/examples/OTA). +Pycom modules come with the ability to update the devices firmware, while it is still running, we call this an "over the air" \(OTA\) update. The [`pycom`](../../firmware-and-api-reference/pycom/pycom.md) library provides several functions to achieve this. This example will demonstrate how you could potentially use this functionality to update deployed devices. The full source code of this example can be found [here](https://github.com/pycom/pycom-libraries/tree/master/examples/OTA). ## Method diff --git a/tutorials/all/owd.md b/tutorials-and-examples/all/owd.md similarity index 100% rename from tutorials/all/owd.md rename to tutorials-and-examples/all/owd.md diff --git a/tutorials/all/pir.md b/tutorials-and-examples/all/pir.md similarity index 100% rename from tutorials/all/pir.md rename to tutorials-and-examples/all/pir.md diff --git a/tutorials/all/repl.md b/tutorials-and-examples/all/repl.md similarity index 100% rename from tutorials/all/repl.md rename to tutorials-and-examples/all/repl.md diff --git a/tutorials/all/rgbled.md b/tutorials-and-examples/all/rgbled.md similarity index 100% rename from tutorials/all/rgbled.md rename to tutorials-and-examples/all/rgbled.md diff --git a/tutorials/all/rmt.md b/tutorials-and-examples/all/rmt.md similarity index 99% rename from tutorials/all/rmt.md rename to tutorials-and-examples/all/rmt.md index 3f09559..008cca5 100644 --- a/tutorials/all/rmt.md +++ b/tutorials-and-examples/all/rmt.md @@ -1,6 +1,6 @@ # RMT -Detailed information about this class can be found in [`RMT`](../../firmwareapi/pycom/machine/rmt.md). +Detailed information about this class can be found in [`RMT`](../../firmware-and-api-reference/pycom/machine/rmt.md). The RMT \(Remote Control\) peripheral of the ESP32 is primarily designed to send and receive infrared remote control signals that use on-off-keying of a carrier frequency, but due to its design it can be used to generate various types of signals, this class will allow you to do this. diff --git a/tutorials/all/socket.md b/tutorials-and-examples/all/socket.md similarity index 99% rename from tutorials/all/socket.md rename to tutorials-and-examples/all/socket.md index 2b9b6af..c29bc56 100644 --- a/tutorials/all/socket.md +++ b/tutorials-and-examples/all/socket.md @@ -1,6 +1,6 @@ # Socket -Detailed information about this class can be found in [usocket](../../firmwareapi/micropython/usocket.md). +Detailed information about this class can be found in [usocket](). ### Setting up a server with blocking sockets diff --git a/tutorials/all/threading.md b/tutorials-and-examples/all/threading.md similarity index 100% rename from tutorials/all/threading.md rename to tutorials-and-examples/all/threading.md diff --git a/tutorials/all/timers.md b/tutorials-and-examples/all/timers.md similarity index 92% rename from tutorials/all/timers.md rename to tutorials-and-examples/all/timers.md index ae1378e..cbeb345 100644 --- a/tutorials/all/timers.md +++ b/tutorials-and-examples/all/timers.md @@ -1,6 +1,6 @@ # Timers -Detailed information about this class can be found in [`Timer`](../../firmwareapi/pycom/machine/timer.md). +Detailed information about this class can be found in [`Timer`](../../firmware-and-api-reference/pycom/machine/timer.md). ## Chronometer @@ -48,6 +48,6 @@ clock = Clock() ``` {% hint style="info" %} -There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](../../firmwareapi/notes.md#interrupt-handling). +There are no restrictions to what can be done in an interrupt. For example, it is possible to even do network requests with an interrupt. However, it is important to keep in mind that interrupts are handled sequentially, so it’s good practice to keep them short. More information can be found in [`Interrupt Handling`](../../firmware-and-api-reference/notes.md#interrupt-handling). {% endhint %} diff --git a/tutorials/all/wlan.md b/tutorials-and-examples/all/wlan.md similarity index 100% rename from tutorials/all/wlan.md rename to tutorials-and-examples/all/wlan.md diff --git a/tutorials/introduction.md b/tutorials-and-examples/introduction.md similarity index 95% rename from tutorials/introduction.md rename to tutorials-and-examples/introduction.md index 752925d..e028c20 100644 --- a/tutorials/introduction.md +++ b/tutorials-and-examples/introduction.md @@ -8,7 +8,7 @@ This section contains tutorials and examples for use with Pycom modules and Expa General Pycom tutorials contains tutorials that may be run on any Pycom device, such as connecting to a WiFi network, Bluetooth, controlling I/O pins etc. Later sections are specific to the LoPy and SiPy devices such as setting up a LoRa node or connecting to the Sigfox network. The final sections are related to examples using the Pytrack and Pysense. -Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../gettingstarted/installation/firmwaretool.md). +Before starting, ensure that any Pycom devices are running the latest firmware; for instructions see [Firmware Updates](../getting-started/installation/firmwaretool.md). The source code for these tutorials, along with the required libraries can be found in in the [pycom-libraries](https://github.com/pycom/pycom-libraries) repository. diff --git a/tutorials/lora/README.md b/tutorials-and-examples/lora/README.md similarity index 100% rename from tutorials/lora/README.md rename to tutorials-and-examples/lora/README.md diff --git a/tutorials/lora/lora-mac-nano-gateway.md b/tutorials-and-examples/lora/lora-mac-nano-gateway.md similarity index 100% rename from tutorials/lora/lora-mac-nano-gateway.md rename to tutorials-and-examples/lora/lora-mac-nano-gateway.md diff --git a/tutorials/lora/lora-mac.md b/tutorials-and-examples/lora/lora-mac.md similarity index 100% rename from tutorials/lora/lora-mac.md rename to tutorials-and-examples/lora/lora-mac.md diff --git a/tutorials/lora/lora-mesh.md b/tutorials-and-examples/lora/lora-mesh.md similarity index 100% rename from tutorials/lora/lora-mesh.md rename to tutorials-and-examples/lora/lora-mesh.md diff --git a/tutorials/lora/lorawan-abp.md b/tutorials-and-examples/lora/lorawan-abp.md similarity index 100% rename from tutorials/lora/lorawan-abp.md rename to tutorials-and-examples/lora/lorawan-abp.md diff --git a/tutorials/lora/lorawan-nano-gateway.md b/tutorials-and-examples/lora/lorawan-nano-gateway.md similarity index 100% rename from tutorials/lora/lorawan-nano-gateway.md rename to tutorials-and-examples/lora/lorawan-nano-gateway.md diff --git a/tutorials/lora/lorawan-otaa.md b/tutorials-and-examples/lora/lorawan-otaa.md similarity index 100% rename from tutorials/lora/lorawan-otaa.md rename to tutorials-and-examples/lora/lorawan-otaa.md diff --git a/tutorials/lora/module-module.md b/tutorials-and-examples/lora/module-module.md similarity index 100% rename from tutorials/lora/module-module.md rename to tutorials-and-examples/lora/module-module.md diff --git a/tutorials/lora/rn2483-to-lopy.md b/tutorials-and-examples/lora/rn2483-to-lopy.md similarity index 100% rename from tutorials/lora/rn2483-to-lopy.md rename to tutorials-and-examples/lora/rn2483-to-lopy.md diff --git a/tutorials/lte/README.md b/tutorials-and-examples/lte/README.md similarity index 100% rename from tutorials/lte/README.md rename to tutorials-and-examples/lte/README.md diff --git a/tutorials/lte/cat-m1.md b/tutorials-and-examples/lte/cat-m1.md similarity index 100% rename from tutorials/lte/cat-m1.md rename to tutorials-and-examples/lte/cat-m1.md diff --git a/tutorials/lte/firmware.md b/tutorials-and-examples/lte/firmware.md similarity index 99% rename from tutorials/lte/firmware.md rename to tutorials-and-examples/lte/firmware.md index 09d9806..a8a3d8f 100644 --- a/tutorials/lte/firmware.md +++ b/tutorials-and-examples/lte/firmware.md @@ -1,7 +1,3 @@ ---- -description: Sequans LTE modem upgrade steps ---- - # Modem Firmware Update {% hint style="info" %} diff --git a/tutorials/lte/imei.md b/tutorials-and-examples/lte/imei.md similarity index 100% rename from tutorials/lte/imei.md rename to tutorials-and-examples/lte/imei.md diff --git a/tutorials/lte/nb-iot.md b/tutorials-and-examples/lte/nb-iot.md similarity index 100% rename from tutorials/lte/nb-iot.md rename to tutorials-and-examples/lte/nb-iot.md diff --git a/tutorials/pyscan.md b/tutorials-and-examples/pyscan.md similarity index 100% rename from tutorials/pyscan.md rename to tutorials-and-examples/pyscan.md diff --git a/tutorials/pysense.md b/tutorials-and-examples/pysense.md similarity index 100% rename from tutorials/pysense.md rename to tutorials-and-examples/pysense.md diff --git a/tutorials/pytrack.md b/tutorials-and-examples/pytrack.md similarity index 100% rename from tutorials/pytrack.md rename to tutorials-and-examples/pytrack.md diff --git a/tutorials/sigfox.md b/tutorials-and-examples/sigfox.md similarity index 97% rename from tutorials/sigfox.md rename to tutorials-and-examples/sigfox.md index 4c789cb..d7d5aa0 100644 --- a/tutorials/sigfox.md +++ b/tutorials-and-examples/sigfox.md @@ -1,6 +1,6 @@ # Sigfox Examples -Before you start, make sure that your device was registered with [Sigfox](../gettingstarted/registration/sigfox.md). +Before you start, make sure that your device was registered with [Sigfox](../getting-started/registration/sigfox.md). The following tutorials demonstrate how to register and get started with the SiPy. The SiPy can be configured for operation in various countries based upon specified RCZ zones \(see the `Sigfox` class for more info\). The SiPy supports both uplink and downlink `Sigfox` messages as well as device to device communication via its FSK Mode `Sigfox`.