Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

750 lines
21 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Remove wifi info from File: dir, Node: Top, This is the top of the INFO tree. This is the Info main menu (aka directory node). A few useful Info commands: 'q' quits; '?' lists all Info commands; 'h' starts the Info tutorial; 'mTexinfo RET' visits the Texinfo manual, etc. * Menu: Basics * Common options: (coreutils)Common options. * Coreutils: (coreutils). Core GNU (file, text, shell) utilities. * Date input formats: (coreutils)Date input formats. * Ed: (ed). The GNU line editor * File permissions: (coreutils)File permissions. Access modes. * Finding files: (find). Operating on files matching certain criteria. C++ libraries * autosprintf: (autosprintf). Support for printf format strings in C++. Compression * Gzip: (gzip). General (de)compression of files (lzw). Development * SSIP: (ssip). Speech Synthesis Interface Protocol. * Speech Dispatcher: (speech-dispatcher). Speech Dispatcher. * libffi: (libffi). Portable foreign-function interface library. DOS * Mtools: (mtools). Mtools: utilities to access DOS disks in Unix. Editors * nano: (nano). Small and friendly text editor. General Commands * Screen: (screen). Full-screen window manager. GNU Gettext Utilities * autopoint: (gettext)autopoint Invocation. Copy gettext infrastructure. * envsubst: (gettext)envsubst Invocation. Expand environment variables. * gettextize: (gettext)gettextize Invocation. Prepare a package for gettext. * gettext: (gettext). GNU gettext utilities. * ISO3166: (gettext)Country Codes. ISO 3166 country codes. * ISO639: (gettext)Language Codes. ISO 639 language codes. * msgattrib: (gettext)msgattrib Invocation. Select part of a PO file. * msgcat: (gettext)msgcat Invocation. Combine several PO files. * msgcmp: (gettext)msgcmp Invocation. Compare a PO file and template. * msgcomm: (gettext)msgcomm Invocation. Match two PO files. * msgconv: (gettext)msgconv Invocation. Convert PO file to encoding. * msgen: (gettext)msgen Invocation. Create an English PO file. * msgexec: (gettext)msgexec Invocation. Process a PO file. * msgfilter: (gettext)msgfilter Invocation. Pipe a PO file through a filter. * msgfmt: (gettext)msgfmt Invocation. Make MO files out of PO files. * msggrep: (gettext)msggrep Invocation. Select part of a PO file. * msginit: (gettext)msginit Invocation. Create a fresh PO file. * msgmerge: (gettext)msgmerge Invocation. Update a PO file from template. * msgunfmt: (gettext)msgunfmt Invocation. Uncompile MO file into PO file. * msguniq: (gettext)msguniq Invocation. Unify duplicates for PO file. * ngettext: (gettext)ngettext Invocation. Translate a message with plural. * xgettext: (gettext)xgettext Invocation. Extract strings into a PO file. GNU organization * Maintaining Findutils: (find-maint). Maintaining GNU findutils GNU Utilities * dirmngr-client: (gnupg). X.509 CRL and OCSP client. * dirmngr: (gnupg). X.509 CRL and OCSP server. * gpg: (gnupg1). OpenPGP encryption and signing tool (v1). * gpg-agent: (gnupg). The secret key daemon. * gpg2: (gnupg). OpenPGP encryption and signing tool. * gpgsm: (gnupg). S/MIME encryption and signing tool. Individual utilities * aclocal-invocation: (automake-1.15)aclocal Invocation. Generating aclocal.m4. * arch: (coreutils)arch invocation. Print machine hardware name. * automake-invocation: (automake-1.15)automake Invocation. Generating Makefile.in. * base32: (coreutils)base32 invocation. Base32 encode/decode data. * base64: (coreutils)base64 invocation. Base64 encode/decode data. * basename: (coreutils)basename invocation. Strip directory and suffix. * bibtex: (web2c)bibtex invocation. Maintaining bibliographies. * cat: (coreutils)cat invocation. Concatenate and write files. * chcon: (coreutils)chcon invocation. Change SELinux CTX of files. * chgrp: (coreutils)chgrp invocation. Change file groups. * chmod: (coreutils)chmod invocation. Change access permissions. * chown: (coreutils)chown invocation. Change file owners and groups. * chroot: (coreutils)chroot invocation. Specify the root directory. * cksum: (coreutils)cksum invocation. Print POSIX CRC checksum. * cmp: (diffutils)Invoking cmp. Compare 2 files byte by byte. * comm: (coreutils)comm invocation. Compare sorted files by line. * cp: (coreutils)cp invocation. Copy files. * csplit: (coreutils)csplit invocation. Split by context. * cut: (coreutils)cut invocation. Print selected parts of lines. * date: (coreutils)date invocation. Print/set system date and time. * dd: (coreutils)dd invocation. Copy and convert a file. * df: (coreutils)df invocation. Report file system disk usage. * diff: (diffutils)Invoking diff. Compare 2 files line by line. * diff3: (diffutils)Invoking diff3. Compare 3 files line by line. * dir: (coreutils)dir invocation. List directories briefly. * dircolors: (coreutils)dircolors invocation. Color setup for ls. * dirname: (coreutils)dirname invocation. Strip last file name component. * du: (coreutils)du invocation. Report on disk usage. * dvicopy: (web2c)dvicopy invocation. Virtual font expansion * dvitomp: (web2c)dvitomp invocation. DVI to MPX (MetaPost pictures). * dvitype: (web2c)dvitype invocation. DVI to human-readable text. * echo: (coreutils)echo invocation. Print a line of text. * env: (coreutils)env invocation. Modify the environment. * expand: (coreutils)expand invocation. Convert tabs to spaces. * expr: (coreutils)expr invocation. Evaluate expressions. * factor: (coreutils)factor invocation. Print prime factors * false: (coreutils)false invocation. Do nothing, unsuccessfully. * find: (find)Invoking find. Finding and acting on files. * fmt: (coreutils)fmt invocation. Reformat paragraph text. * fold: (coreutils)fold invocation. Wrap long input lines. * gftodvi: (web2c)gftodvi invocation. Generic font proofsheets. * gftopk: (web2c)gftopk invocation. Generic to packed fonts. * gftype: (web2c)gftype invocation. GF to human-readable text. * groups: (coreutils)groups invocation. Print group names a user is in. * gunzip: (gzip)Overview. Decompression. * gzexe: (gzip)Overview. Compress executables. * head: (coreutils)head invocation. Output the first part of files. * hostid: (coreutils)hostid invocation. Print numeric host identifier. * hostname: (coreutils)hostname invocation. Print or set system name. * id: (coreutils)id invocation. Print user identity. * install: (coreutils)install invocation. Copy files and set attributes. * join: (coreutils)join invocation. Join lines on a common field. * kill: (coreutils)kill invocation. Send a signal to processes. * link: (coreutils)link invocation. Make hard links between files. * ln: (coreutils)ln invocation. Make links between files. * locate: (find)Invoking locate. Finding files in a database. * logname: (coreutils)logname invocation. Print current login name. * ls: (coreutils)ls invocation. List directory contents. * md5sum: (coreutils)md5sum invocation. Print or check MD5 digests. * mf: (web2c)mf invocation. Creating typeface families. * mft: (web2c)mft invocation. Prettyprinting Metafont source. * mkdir: (coreutils)mkdir invocation. Create directories. * mkfifo: (coreutils)mkfifo invocation. Create FIFOs (named pipes). * mknod: (coreutils)mknod invocation. Create special files. * mktemp: (coreutils)mktemp invocation. Create temporary files. * mltex: (web2c)MLTeX. Multi-lingual TeX. * mpost: (web2c)mpost invocation. Creating technical diagrams. * mv: (coreutils)mv invocation. Rename files. * nice: (coreutils)nice invocation. Modify niceness. * nl: (coreutils)nl invocation. Number lines and write files. * nohup: (coreutils)nohup invocation. Immunize to hangups. * nproc: (coreutils)nproc invocation. Print the number of processors. * numfmt: (coreutils)numfmt invocation. Reformat numbers. * od: (coreutils)od invocation. Dump files in octal, etc. * paste: (coreutils)paste invocation. Merge lines of files. * patch: (diffutils)Invoking patch. Apply a patch to a file. * patgen: (web2c)patgen invocation. Creating hyphenation patterns. * pathchk: (coreutils)pathchk invocation. Check file name portability. * pktogf: (web2c)pktogf invocation. Packed to generic fonts. * pktype: (web2c)pktype invocation. PK to human-readable text. * pltotf: (web2c)pltotf invocation. Property list to TFM. * pooltype: (web2c)pooltype invocation. Display WEB pool files. * pr: (coreutils)pr invocation. Paginate or columnate files. * printenv: (coreutils)printenv invocation. Print environment variables. * printf: (coreutils)printf invocation. Format and print data. * ptx: (coreutils)ptx invocation. Produce permuted indexes. * pwd: (coreutils)pwd invocation. Print working directory. * readlink: (coreutils)readlink invocation. Print referent of a symlink. * realpath: (coreutils)realpath invocation. Print resolved file names. * rm: (coreutils)rm invocation. Remove files. * rmdir: (coreutils)rmdir invocation. Remove empty directories. * runcon: (coreutils)runcon invocation. Run in specified SELinux CTX. * sdiff: (diffutils)Invoking sdiff. Merge 2 files side-by-side. * seq: (coreutils)seq invocation. Print numeric sequences * sha1sum: (coreutils)sha1sum invocation. Print or check SHA-1 digests. * sha2: (coreutils)sha2 utilities. Print or check SHA-2 digests. * shred: (coreutils)shred invocation. Remove files more securely. * shuf: (coreutils)shuf invocation. Shuffling text files. * sleep: (coreutils)sleep invocation. Delay for a specified time. * sort: (coreutils)sort invocation. Sort text files. * split: (coreutils)split invocation. Split into pieces. * stat: (coreutils)stat invocation. Report file(system) status. * stdbuf: (coreutils)stdbuf invocation. Modify stdio buffering. * stty: (coreutils)stty invocation. Print/change terminal settings. * sum: (coreutils)sum invocation. Print traditional checksum. * sync: (coreutils)sync invocation. Synchronize memory to disk. * tac: (coreutils)tac invocation. Reverse files. * tail: (coreutils)tail invocation. Output the last part of files. * tangle: (web2c)tangle invocation. WEB to Pascal. * tee: (coreutils)tee invocation. Redirect to multiple files. * test: (coreutils)test invocation. File/string tests. * tex: (web2c)tex invocation. Typesetting. * tftopl: (web2c)tftopl invocation. TFM -> property list. * time: (time). Run programs and summarize system resource usage. * timeout: (coreutils)timeout invocation. Run with time limit. * touch: (coreutils)touch invocation. Change file timestamps. * tr: (coreutils)tr invocation. Translate characters. * true: (coreutils)true invocation. Do nothing, successfully. * truncate: (coreutils)truncate invocation. Shrink/extend size of a file. * tsort: (coreutils)tsort invocation. Topological sort. * tty: (coreutils)tty invocation. Print terminal name. * uname: (coreutils)uname invocation. Print system information. * unexpand: (coreutils)unexpand invocation. Convert spaces to tabs. * uniq: (coreutils)uniq invocation. Uniquify files. * unlink: (coreutils)unlink invocation. Removal via unlink(2). * updatedb: (find)Invoking updatedb. Building the locate database. * uptime: (coreutils)uptime invocation. Print uptime and load. * users: (coreutils)users invocation. Print current user names. * vdir: (coreutils)vdir invocation. List directories verbosely. * vftovp: (web2c)vftovp invocation. Virtual font -> virtual pl. * vptovf: (web2c)vptovf invocation. Virtual pl -> virtual font. * wc: (coreutils)wc invocation. Line, word, and byte counts. * weave: (web2c)weave invocation. WEB to TeX. * who: (coreutils)who invocation. Print who is logged in. * whoami: (coreutils)whoami invocation. Print effective user ID. * xargs: (find)Invoking xargs. Operating on many files. * yes: (coreutils)yes invocation. Print a string indefinitely. * zcat: (gzip)Overview. Decompression to stdout. * zdiff: (gzip)Overview. Compare compressed files. * zforce: (gzip)Overview. Force .gz extension on files. * zgrep: (gzip)Overview. Search compressed files. * zmore: (gzip)Overview. Decompression output by pages. Kernel * GRUB: (grub). The GRand Unified Bootloader * grub-dev: (grub-dev). The GRand Unified Bootloader Dev * grub-install: (grub)Invoking grub-install. Install GRUB on your drive * grub-mkconfig: (grub)Invoking grub-mkconfig. Generate GRUB configuration * grub-mkpasswd-pbkdf2: (grub)Invoking grub-mkpasswd-pbkdf2. * grub-mkrelpath: (grub)Invoking grub-mkrelpath. * grub-mkrescue: (grub)Invoking grub-mkrescue. Make a GRUB rescue image * grub-mount: (grub)Invoking grub-mount. Mount a file system using GRUB * grub-probe: (grub)Invoking grub-probe. Probe device information * grub-script-check: (grub)Invoking grub-script-check. Libraries * RLuserman: (rluserman). The GNU readline library User's Manual. Man-pages * Latex2man: (latex2man). Its Man-Page Math * bc: (bc). An arbitrary precision calculator language. * dc: (dc). Arbitrary precision RPN "Desktop Calculator". Network applications * Wget: (wget). Non-interactive network downloader. Programming * flex: (flex). Fast lexical analyzer generator (lex replacement). * gnucash: (gnucash-design). Design of the GnuCash program Programming Tools * Gperf: (gperf). Perfect Hash Function Generator. Software development * Autoconf Archive: (autoconf-archive). A collection of re-usable Autoconf macros. * Automake: (automake-1.15). Making GNU standards-compliant Makefiles. Sound * SSIP: (ssip). Speech Synthesis Interface Protocol. * Say for Speech Dispatcher: (spd-say). Say. * Speech Dispatcher: (speech-dispatcher). Speech Dispatcher. TeX * DVI-to-PNG: (dvipng). Translating TeX DVI files to Portable Network Graphics (PNG). * DVI-to-Postscript: (dvips). Translating TeX DVI files to PostScript. * Eplain: (eplain). Expanding on plain Tex. * EpsPDF: (epspdf). Portable GUI- and command-line EPS/PS/PDF conversion * Kpathsea: (kpathsea). File lookup along search paths. * LaTeX2e: (latex2e). Unofficial LaTeX reference manual. * LaTeX2e-es: (latex2e-es). Manual de extraoficial de LaTeX. * Naming TeX fonts: (fontname). Filenames for TeX fonts. * TL-build: (tlbuild). TeX Live configuration and development. * TeX Directories: (tds). A directory structure for TeX files. * TeXdraw: (texdraw). A system for producing PostScript drawings from TeX. * Web2c: (web2c). TeX, Metafont, and companion programs. * afm2tfm: (dvips)Invoking afm2tfm. Making Type 1 fonts available to TeX. * dvipng: (dvipng). A DVI-to-PNG translator. * dvips: (dvips)Invoking Dvips. DVI-to-PostScript translator. * kpsewhich: (kpathsea)Invoking kpsewhich. TeX file searching. * mf2pt1: (mf2pt1). PostScript Type 1 fonts from Metafont source. * mktexfmt: (kpathsea)mktex scripts. Format (fmt/base/mem) generation. * mktexlsr: (kpathsea)Filename database. Update ls-R. * mktexmf: (kpathsea)mktex scripts. MF source generation. * mktexpk: (kpathsea)mktex scripts. PK bitmap generation. * mktextex: (kpathsea)mktex scripts. TeX source generation. * mktextfm: (kpathsea)mktex scripts. TeX font metric generation. Text creation and manipulation * Diffutils: (diffutils). Comparing and merging files. * M4: (m4). A powerful macro processor. * grep: (grep). Print lines matching a pattern. * sed: (sed). Stream EDitor. command. Use * SSID MODE CHAN RATE SIGNAL BARS SECURITY to get current connections
6 years ago
Remove wifi info from File: dir, Node: Top, This is the top of the INFO tree. This is the Info main menu (aka directory node). A few useful Info commands: 'q' quits; '?' lists all Info commands; 'h' starts the Info tutorial; 'mTexinfo RET' visits the Texinfo manual, etc. * Menu: Basics * Common options: (coreutils)Common options. * Coreutils: (coreutils). Core GNU (file, text, shell) utilities. * Date input formats: (coreutils)Date input formats. * Ed: (ed). The GNU line editor * File permissions: (coreutils)File permissions. Access modes. * Finding files: (find). Operating on files matching certain criteria. C++ libraries * autosprintf: (autosprintf). Support for printf format strings in C++. Compression * Gzip: (gzip). General (de)compression of files (lzw). Development * SSIP: (ssip). Speech Synthesis Interface Protocol. * Speech Dispatcher: (speech-dispatcher). Speech Dispatcher. * libffi: (libffi). Portable foreign-function interface library. DOS * Mtools: (mtools). Mtools: utilities to access DOS disks in Unix. Editors * nano: (nano). Small and friendly text editor. General Commands * Screen: (screen). Full-screen window manager. GNU Gettext Utilities * autopoint: (gettext)autopoint Invocation. Copy gettext infrastructure. * envsubst: (gettext)envsubst Invocation. Expand environment variables. * gettextize: (gettext)gettextize Invocation. Prepare a package for gettext. * gettext: (gettext). GNU gettext utilities. * ISO3166: (gettext)Country Codes. ISO 3166 country codes. * ISO639: (gettext)Language Codes. ISO 639 language codes. * msgattrib: (gettext)msgattrib Invocation. Select part of a PO file. * msgcat: (gettext)msgcat Invocation. Combine several PO files. * msgcmp: (gettext)msgcmp Invocation. Compare a PO file and template. * msgcomm: (gettext)msgcomm Invocation. Match two PO files. * msgconv: (gettext)msgconv Invocation. Convert PO file to encoding. * msgen: (gettext)msgen Invocation. Create an English PO file. * msgexec: (gettext)msgexec Invocation. Process a PO file. * msgfilter: (gettext)msgfilter Invocation. Pipe a PO file through a filter. * msgfmt: (gettext)msgfmt Invocation. Make MO files out of PO files. * msggrep: (gettext)msggrep Invocation. Select part of a PO file. * msginit: (gettext)msginit Invocation. Create a fresh PO file. * msgmerge: (gettext)msgmerge Invocation. Update a PO file from template. * msgunfmt: (gettext)msgunfmt Invocation. Uncompile MO file into PO file. * msguniq: (gettext)msguniq Invocation. Unify duplicates for PO file. * ngettext: (gettext)ngettext Invocation. Translate a message with plural. * xgettext: (gettext)xgettext Invocation. Extract strings into a PO file. GNU organization * Maintaining Findutils: (find-maint). Maintaining GNU findutils GNU Utilities * dirmngr-client: (gnupg). X.509 CRL and OCSP client. * dirmngr: (gnupg). X.509 CRL and OCSP server. * gpg: (gnupg1). OpenPGP encryption and signing tool (v1). * gpg-agent: (gnupg). The secret key daemon. * gpg2: (gnupg). OpenPGP encryption and signing tool. * gpgsm: (gnupg). S/MIME encryption and signing tool. Individual utilities * aclocal-invocation: (automake-1.15)aclocal Invocation. Generating aclocal.m4. * arch: (coreutils)arch invocation. Print machine hardware name. * automake-invocation: (automake-1.15)automake Invocation. Generating Makefile.in. * base32: (coreutils)base32 invocation. Base32 encode/decode data. * base64: (coreutils)base64 invocation. Base64 encode/decode data. * basename: (coreutils)basename invocation. Strip directory and suffix. * bibtex: (web2c)bibtex invocation. Maintaining bibliographies. * cat: (coreutils)cat invocation. Concatenate and write files. * chcon: (coreutils)chcon invocation. Change SELinux CTX of files. * chgrp: (coreutils)chgrp invocation. Change file groups. * chmod: (coreutils)chmod invocation. Change access permissions. * chown: (coreutils)chown invocation. Change file owners and groups. * chroot: (coreutils)chroot invocation. Specify the root directory. * cksum: (coreutils)cksum invocation. Print POSIX CRC checksum. * cmp: (diffutils)Invoking cmp. Compare 2 files byte by byte. * comm: (coreutils)comm invocation. Compare sorted files by line. * cp: (coreutils)cp invocation. Copy files. * csplit: (coreutils)csplit invocation. Split by context. * cut: (coreutils)cut invocation. Print selected parts of lines. * date: (coreutils)date invocation. Print/set system date and time. * dd: (coreutils)dd invocation. Copy and convert a file. * df: (coreutils)df invocation. Report file system disk usage. * diff: (diffutils)Invoking diff. Compare 2 files line by line. * diff3: (diffutils)Invoking diff3. Compare 3 files line by line. * dir: (coreutils)dir invocation. List directories briefly. * dircolors: (coreutils)dircolors invocation. Color setup for ls. * dirname: (coreutils)dirname invocation. Strip last file name component. * du: (coreutils)du invocation. Report on disk usage. * dvicopy: (web2c)dvicopy invocation. Virtual font expansion * dvitomp: (web2c)dvitomp invocation. DVI to MPX (MetaPost pictures). * dvitype: (web2c)dvitype invocation. DVI to human-readable text. * echo: (coreutils)echo invocation. Print a line of text. * env: (coreutils)env invocation. Modify the environment. * expand: (coreutils)expand invocation. Convert tabs to spaces. * expr: (coreutils)expr invocation. Evaluate expressions. * factor: (coreutils)factor invocation. Print prime factors * false: (coreutils)false invocation. Do nothing, unsuccessfully. * find: (find)Invoking find. Finding and acting on files. * fmt: (coreutils)fmt invocation. Reformat paragraph text. * fold: (coreutils)fold invocation. Wrap long input lines. * gftodvi: (web2c)gftodvi invocation. Generic font proofsheets. * gftopk: (web2c)gftopk invocation. Generic to packed fonts. * gftype: (web2c)gftype invocation. GF to human-readable text. * groups: (coreutils)groups invocation. Print group names a user is in. * gunzip: (gzip)Overview. Decompression. * gzexe: (gzip)Overview. Compress executables. * head: (coreutils)head invocation. Output the first part of files. * hostid: (coreutils)hostid invocation. Print numeric host identifier. * hostname: (coreutils)hostname invocation. Print or set system name. * id: (coreutils)id invocation. Print user identity. * install: (coreutils)install invocation. Copy files and set attributes. * join: (coreutils)join invocation. Join lines on a common field. * kill: (coreutils)kill invocation. Send a signal to processes. * link: (coreutils)link invocation. Make hard links between files. * ln: (coreutils)ln invocation. Make links between files. * locate: (find)Invoking locate. Finding files in a database. * logname: (coreutils)logname invocation. Print current login name. * ls: (coreutils)ls invocation. List directory contents. * md5sum: (coreutils)md5sum invocation. Print or check MD5 digests. * mf: (web2c)mf invocation. Creating typeface families. * mft: (web2c)mft invocation. Prettyprinting Metafont source. * mkdir: (coreutils)mkdir invocation. Create directories. * mkfifo: (coreutils)mkfifo invocation. Create FIFOs (named pipes). * mknod: (coreutils)mknod invocation. Create special files. * mktemp: (coreutils)mktemp invocation. Create temporary files. * mltex: (web2c)MLTeX. Multi-lingual TeX. * mpost: (web2c)mpost invocation. Creating technical diagrams. * mv: (coreutils)mv invocation. Rename files. * nice: (coreutils)nice invocation. Modify niceness. * nl: (coreutils)nl invocation. Number lines and write files. * nohup: (coreutils)nohup invocation. Immunize to hangups. * nproc: (coreutils)nproc invocation. Print the number of processors. * numfmt: (coreutils)numfmt invocation. Reformat numbers. * od: (coreutils)od invocation. Dump files in octal, etc. * paste: (coreutils)paste invocation. Merge lines of files. * patch: (diffutils)Invoking patch. Apply a patch to a file. * patgen: (web2c)patgen invocation. Creating hyphenation patterns. * pathchk: (coreutils)pathchk invocation. Check file name portability. * pktogf: (web2c)pktogf invocation. Packed to generic fonts. * pktype: (web2c)pktype invocation. PK to human-readable text. * pltotf: (web2c)pltotf invocation. Property list to TFM. * pooltype: (web2c)pooltype invocation. Display WEB pool files. * pr: (coreutils)pr invocation. Paginate or columnate files. * printenv: (coreutils)printenv invocation. Print environment variables. * printf: (coreutils)printf invocation. Format and print data. * ptx: (coreutils)ptx invocation. Produce permuted indexes. * pwd: (coreutils)pwd invocation. Print working directory. * readlink: (coreutils)readlink invocation. Print referent of a symlink. * realpath: (coreutils)realpath invocation. Print resolved file names. * rm: (coreutils)rm invocation. Remove files. * rmdir: (coreutils)rmdir invocation. Remove empty directories. * runcon: (coreutils)runcon invocation. Run in specified SELinux CTX. * sdiff: (diffutils)Invoking sdiff. Merge 2 files side-by-side. * seq: (coreutils)seq invocation. Print numeric sequences * sha1sum: (coreutils)sha1sum invocation. Print or check SHA-1 digests. * sha2: (coreutils)sha2 utilities. Print or check SHA-2 digests. * shred: (coreutils)shred invocation. Remove files more securely. * shuf: (coreutils)shuf invocation. Shuffling text files. * sleep: (coreutils)sleep invocation. Delay for a specified time. * sort: (coreutils)sort invocation. Sort text files. * split: (coreutils)split invocation. Split into pieces. * stat: (coreutils)stat invocation. Report file(system) status. * stdbuf: (coreutils)stdbuf invocation. Modify stdio buffering. * stty: (coreutils)stty invocation. Print/change terminal settings. * sum: (coreutils)sum invocation. Print traditional checksum. * sync: (coreutils)sync invocation. Synchronize memory to disk. * tac: (coreutils)tac invocation. Reverse files. * tail: (coreutils)tail invocation. Output the last part of files. * tangle: (web2c)tangle invocation. WEB to Pascal. * tee: (coreutils)tee invocation. Redirect to multiple files. * test: (coreutils)test invocation. File/string tests. * tex: (web2c)tex invocation. Typesetting. * tftopl: (web2c)tftopl invocation. TFM -> property list. * time: (time). Run programs and summarize system resource usage. * timeout: (coreutils)timeout invocation. Run with time limit. * touch: (coreutils)touch invocation. Change file timestamps. * tr: (coreutils)tr invocation. Translate characters. * true: (coreutils)true invocation. Do nothing, successfully. * truncate: (coreutils)truncate invocation. Shrink/extend size of a file. * tsort: (coreutils)tsort invocation. Topological sort. * tty: (coreutils)tty invocation. Print terminal name. * uname: (coreutils)uname invocation. Print system information. * unexpand: (coreutils)unexpand invocation. Convert spaces to tabs. * uniq: (coreutils)uniq invocation. Uniquify files. * unlink: (coreutils)unlink invocation. Removal via unlink(2). * updatedb: (find)Invoking updatedb. Building the locate database. * uptime: (coreutils)uptime invocation. Print uptime and load. * users: (coreutils)users invocation. Print current user names. * vdir: (coreutils)vdir invocation. List directories verbosely. * vftovp: (web2c)vftovp invocation. Virtual font -> virtual pl. * vptovf: (web2c)vptovf invocation. Virtual pl -> virtual font. * wc: (coreutils)wc invocation. Line, word, and byte counts. * weave: (web2c)weave invocation. WEB to TeX. * who: (coreutils)who invocation. Print who is logged in. * whoami: (coreutils)whoami invocation. Print effective user ID. * xargs: (find)Invoking xargs. Operating on many files. * yes: (coreutils)yes invocation. Print a string indefinitely. * zcat: (gzip)Overview. Decompression to stdout. * zdiff: (gzip)Overview. Compare compressed files. * zforce: (gzip)Overview. Force .gz extension on files. * zgrep: (gzip)Overview. Search compressed files. * zmore: (gzip)Overview. Decompression output by pages. Kernel * GRUB: (grub). The GRand Unified Bootloader * grub-dev: (grub-dev). The GRand Unified Bootloader Dev * grub-install: (grub)Invoking grub-install. Install GRUB on your drive * grub-mkconfig: (grub)Invoking grub-mkconfig. Generate GRUB configuration * grub-mkpasswd-pbkdf2: (grub)Invoking grub-mkpasswd-pbkdf2. * grub-mkrelpath: (grub)Invoking grub-mkrelpath. * grub-mkrescue: (grub)Invoking grub-mkrescue. Make a GRUB rescue image * grub-mount: (grub)Invoking grub-mount. Mount a file system using GRUB * grub-probe: (grub)Invoking grub-probe. Probe device information * grub-script-check: (grub)Invoking grub-script-check. Libraries * RLuserman: (rluserman). The GNU readline library User's Manual. Man-pages * Latex2man: (latex2man). Its Man-Page Math * bc: (bc). An arbitrary precision calculator language. * dc: (dc). Arbitrary precision RPN "Desktop Calculator". Network applications * Wget: (wget). Non-interactive network downloader. Programming * flex: (flex). Fast lexical analyzer generator (lex replacement). * gnucash: (gnucash-design). Design of the GnuCash program Programming Tools * Gperf: (gperf). Perfect Hash Function Generator. Software development * Autoconf Archive: (autoconf-archive). A collection of re-usable Autoconf macros. * Automake: (automake-1.15). Making GNU standards-compliant Makefiles. Sound * SSIP: (ssip). Speech Synthesis Interface Protocol. * Say for Speech Dispatcher: (spd-say). Say. * Speech Dispatcher: (speech-dispatcher). Speech Dispatcher. TeX * DVI-to-PNG: (dvipng). Translating TeX DVI files to Portable Network Graphics (PNG). * DVI-to-Postscript: (dvips). Translating TeX DVI files to PostScript. * Eplain: (eplain). Expanding on plain Tex. * EpsPDF: (epspdf). Portable GUI- and command-line EPS/PS/PDF conversion * Kpathsea: (kpathsea). File lookup along search paths. * LaTeX2e: (latex2e). Unofficial LaTeX reference manual. * LaTeX2e-es: (latex2e-es). Manual de extraoficial de LaTeX. * Naming TeX fonts: (fontname). Filenames for TeX fonts. * TL-build: (tlbuild). TeX Live configuration and development. * TeX Directories: (tds). A directory structure for TeX files. * TeXdraw: (texdraw). A system for producing PostScript drawings from TeX. * Web2c: (web2c). TeX, Metafont, and companion programs. * afm2tfm: (dvips)Invoking afm2tfm. Making Type 1 fonts available to TeX. * dvipng: (dvipng). A DVI-to-PNG translator. * dvips: (dvips)Invoking Dvips. DVI-to-PostScript translator. * kpsewhich: (kpathsea)Invoking kpsewhich. TeX file searching. * mf2pt1: (mf2pt1). PostScript Type 1 fonts from Metafont source. * mktexfmt: (kpathsea)mktex scripts. Format (fmt/base/mem) generation. * mktexlsr: (kpathsea)Filename database. Update ls-R. * mktexmf: (kpathsea)mktex scripts. MF source generation. * mktexpk: (kpathsea)mktex scripts. PK bitmap generation. * mktextex: (kpathsea)mktex scripts. TeX source generation. * mktextfm: (kpathsea)mktex scripts. TeX font metric generation. Text creation and manipulation * Diffutils: (diffutils). Comparing and merging files. * M4: (m4). A powerful macro processor. * grep: (grep). Print lines matching a pattern. * sed: (sed). Stream EDitor. command. Use * SSID MODE CHAN RATE SIGNAL BARS SECURITY to get current connections
6 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
Terminal: change command-line parser (#2247) Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
4 years ago
8 years ago
8 years ago
7 years ago
7 years ago
  1. /*
  2. WIFI MODULE
  3. Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
  4. */
  5. #include "wifi.h"
  6. #include "wifi_config.h"
  7. #include "telnet.h"
  8. #include "ws.h"
  9. bool _wifi_wps_running = false;
  10. bool _wifi_smartconfig_running = false;
  11. bool _wifi_smartconfig_initial = false;
  12. int _wifi_ap_mode = WIFI_AP_FALLBACK;
  13. #if WIFI_GRATUITOUS_ARP_SUPPORT
  14. unsigned long _wifi_gratuitous_arp_interval = 0;
  15. unsigned long _wifi_gratuitous_arp_last = 0;
  16. #endif
  17. // -----------------------------------------------------------------------------
  18. // PRIVATE
  19. // -----------------------------------------------------------------------------
  20. struct wifi_scan_info_t {
  21. String ssid_scan;
  22. int32_t rssi_scan;
  23. uint8_t sec_scan;
  24. uint8_t* BSSID_scan;
  25. int32_t chan_scan;
  26. bool hidden_scan;
  27. char buffer[128];
  28. };
  29. using wifi_scan_f = std::function<void(wifi_scan_info_t& info)>;
  30. void _wifiUpdateSoftAP() {
  31. if (WiFi.softAPgetStationNum() == 0) {
  32. #if USE_PASSWORD
  33. jw.setSoftAP(getSetting("hostname").c_str(), getAdminPass().c_str());
  34. #else
  35. jw.setSoftAP(getSetting("hostname").c_str());
  36. #endif
  37. }
  38. }
  39. void _wifiCheckAP() {
  40. if (
  41. (WIFI_AP_FALLBACK == _wifi_ap_mode)
  42. && ((WiFi.getMode() & WIFI_AP) > 0)
  43. && jw.connected()
  44. && (WiFi.softAPgetStationNum() == 0)
  45. ) {
  46. jw.enableAP(false);
  47. }
  48. }
  49. namespace settings {
  50. namespace internal {
  51. template<>
  52. WiFiSleepType_t convert(const String& value) {
  53. switch (value.toInt()) {
  54. case 2:
  55. return WIFI_MODEM_SLEEP;
  56. case 1:
  57. return WIFI_LIGHT_SLEEP;
  58. case 0:
  59. default:
  60. return WIFI_NONE_SLEEP;
  61. }
  62. }
  63. }
  64. }
  65. void _wifiConfigure() {
  66. jw.setHostname(getSetting("hostname").c_str());
  67. _wifiUpdateSoftAP();
  68. jw.setConnectTimeout(WIFI_CONNECT_TIMEOUT);
  69. wifiReconnectCheck();
  70. jw.enableAPFallback(WIFI_FALLBACK_APMODE);
  71. jw.cleanNetworks();
  72. _wifi_ap_mode = getSetting("apmode", WIFI_AP_FALLBACK);
  73. // If system is flagged unstable we do not init wifi networks
  74. #if SYSTEM_CHECK_ENABLED
  75. if (!systemCheck()) return;
  76. #endif
  77. unsigned char index = 0;
  78. for (index = 0; index < WIFI_MAX_NETWORKS; index++) {
  79. const auto ssid = getSetting({"ssid", index}, _wifiSSID(index));
  80. const auto pass = getSetting({"pass", index}, _wifiPass(index));
  81. if (!ssid.length()) {
  82. auto current = index;
  83. do {
  84. delSetting({"ssid", index});
  85. delSetting({"pass", index});
  86. delSetting({"ip", index});
  87. delSetting({"gw", index});
  88. delSetting({"mask", index});
  89. delSetting({"dns", index});
  90. } while (++index < WIFI_MAX_NETWORKS);
  91. index = current;
  92. break;
  93. }
  94. bool result = false;
  95. if (ssid.length() && pass.length()) {
  96. result = jw.addNetwork(
  97. ssid.c_str(),
  98. pass.c_str(),
  99. getSetting({"ip", index}, _wifiIP(index)).c_str(),
  100. getSetting({"gw", index}, _wifiGateway(index)).c_str(),
  101. getSetting({"mask", index}, _wifiNetmask(index)).c_str(),
  102. getSetting({"dns", index}, _wifiDNS(index)).c_str()
  103. );
  104. } else if (ssid.length()) {
  105. result = jw.addNetwork(ssid.c_str(), pass.c_str());
  106. }
  107. if (!result) break;
  108. }
  109. #if JUSTWIFI_ENABLE_SMARTCONFIG
  110. if (index == 0) _wifi_smartconfig_initial = true;
  111. #endif
  112. jw.enableScan(getSetting("wifiScan", 1 == WIFI_SCAN_NETWORKS));
  113. const auto sleep_mode = getSetting("wifiSleep", WIFI_SLEEP_MODE);
  114. WiFi.setSleepMode(sleep_mode);
  115. #if WIFI_GRATUITOUS_ARP_SUPPORT
  116. _wifi_gratuitous_arp_last = millis();
  117. _wifi_gratuitous_arp_interval = getSetting("wifiGarpIntvl", secureRandom(
  118. WIFI_GRATUITOUS_ARP_INTERVAL_MIN, WIFI_GRATUITOUS_ARP_INTERVAL_MAX
  119. ));
  120. #endif
  121. const auto tx_power = getSetting("wifiTxPwr", WIFI_OUTPUT_POWER_DBM);
  122. WiFi.setOutputPower(tx_power);
  123. }
  124. void _wifiScan(wifi_scan_f callback = nullptr) {
  125. DEBUG_MSG_P(PSTR("[WIFI] Start scanning\n"));
  126. unsigned char result = WiFi.scanNetworks();
  127. if (result == WIFI_SCAN_FAILED) {
  128. DEBUG_MSG_P(PSTR("[WIFI] Scan failed\n"));
  129. return;
  130. } else if (result == 0) {
  131. DEBUG_MSG_P(PSTR("[WIFI] No networks found\n"));
  132. return;
  133. }
  134. DEBUG_MSG_P(PSTR("[WIFI] %d networks found:\n"), result);
  135. // Populate defined networks with scan data
  136. wifi_scan_info_t info;
  137. for (unsigned char i = 0; i < result; ++i) {
  138. WiFi.getNetworkInfo(i, info.ssid_scan, info.sec_scan, info.rssi_scan, info.BSSID_scan, info.chan_scan, info.hidden_scan);
  139. snprintf_P(info.buffer, sizeof(info.buffer),
  140. PSTR("BSSID: %02X:%02X:%02X:%02X:%02X:%02X SEC: %s RSSI: %3d CH: %2d SSID: %s"),
  141. info.BSSID_scan[0], info.BSSID_scan[1], info.BSSID_scan[2], info.BSSID_scan[3], info.BSSID_scan[4], info.BSSID_scan[5],
  142. (info.sec_scan != ENC_TYPE_NONE ? "YES" : "NO "),
  143. info.rssi_scan,
  144. info.chan_scan,
  145. info.ssid_scan.c_str()
  146. );
  147. if (callback) {
  148. callback(info);
  149. } else {
  150. DEBUG_MSG_P(PSTR("[WIFI] > %s\n"), info.buffer);
  151. }
  152. }
  153. WiFi.scanDelete();
  154. }
  155. void _wifiCallback(justwifi_messages_t code, char * parameter) {
  156. if (MESSAGE_WPS_START == code) {
  157. _wifi_wps_running = true;
  158. return;
  159. }
  160. if (MESSAGE_SMARTCONFIG_START == code) {
  161. _wifi_smartconfig_running = true;
  162. return;
  163. }
  164. if (MESSAGE_WPS_ERROR == code || MESSAGE_SMARTCONFIG_ERROR == code) {
  165. _wifi_wps_running = false;
  166. _wifi_smartconfig_running = false;
  167. return;
  168. }
  169. if (MESSAGE_WPS_SUCCESS == code || MESSAGE_SMARTCONFIG_SUCCESS == code) {
  170. _wifi_wps_running = false;
  171. _wifi_smartconfig_running = false;
  172. const String current_ssid = WiFi.SSID();
  173. const String current_pass = WiFi.psk();
  174. // Write current ssid & pass at the end of the networks list
  175. unsigned char count;
  176. for (count = 0; count < WIFI_MAX_NETWORKS; count++) {
  177. const auto ssid = getSetting({"ssid", count}, _wifiSSID(count));
  178. const auto pass = getSetting({"pass", count}, _wifiPass(count));
  179. // Ignore existing network settings
  180. if (current_ssid.equals(ssid) && current_pass.equals(pass)) {
  181. return;
  182. }
  183. if (current_ssid.equals(ssid)) break;
  184. if (!ssid.length()) break;
  185. }
  186. // If we have reached the max we overwrite the first one
  187. if (WIFI_MAX_NETWORKS == count) count = 0;
  188. setSetting({"ssid", count}, current_ssid);
  189. setSetting({"pass", count}, current_pass);
  190. return;
  191. }
  192. }
  193. #if WIFI_AP_CAPTIVE
  194. #include "DNSServer.h"
  195. DNSServer _wifi_dnsServer;
  196. void _wifiCaptivePortal(justwifi_messages_t code, char * parameter) {
  197. if (MESSAGE_ACCESSPOINT_CREATED == code) {
  198. _wifi_dnsServer.setErrorReplyCode(DNSReplyCode::NoError);
  199. _wifi_dnsServer.start(53, "*", WiFi.softAPIP());
  200. DEBUG_MSG_P(PSTR("[WIFI] Captive portal enabled\n"));
  201. }
  202. if (MESSAGE_CONNECTED == code) {
  203. _wifi_dnsServer.stop();
  204. DEBUG_MSG_P(PSTR("[WIFI] Captive portal disabled\n"));
  205. }
  206. }
  207. #endif // WIFI_AP_CAPTIVE
  208. #if DEBUG_SUPPORT
  209. void _wifiDebugCallback(justwifi_messages_t code, char * parameter) {
  210. // -------------------------------------------------------------------------
  211. if (code == MESSAGE_SCANNING) {
  212. DEBUG_MSG_P(PSTR("[WIFI] Scanning\n"));
  213. }
  214. if (code == MESSAGE_SCAN_FAILED) {
  215. DEBUG_MSG_P(PSTR("[WIFI] Scan failed\n"));
  216. }
  217. if (code == MESSAGE_NO_NETWORKS) {
  218. DEBUG_MSG_P(PSTR("[WIFI] No networks found\n"));
  219. }
  220. if (code == MESSAGE_NO_KNOWN_NETWORKS) {
  221. DEBUG_MSG_P(PSTR("[WIFI] No known networks found\n"));
  222. }
  223. if (code == MESSAGE_FOUND_NETWORK) {
  224. DEBUG_MSG_P(PSTR("[WIFI] %s\n"), parameter);
  225. }
  226. // -------------------------------------------------------------------------
  227. if (code == MESSAGE_CONNECTING) {
  228. DEBUG_MSG_P(PSTR("[WIFI] Connecting to %s\n"), parameter);
  229. }
  230. if (code == MESSAGE_CONNECT_WAITING) {
  231. // too much noise
  232. }
  233. if (code == MESSAGE_CONNECT_FAILED) {
  234. DEBUG_MSG_P(PSTR("[WIFI] Could not connect to %s\n"), parameter);
  235. }
  236. if (code == MESSAGE_CONNECTED) {
  237. wifiDebug(WIFI_STA);
  238. }
  239. if (code == MESSAGE_DISCONNECTED) {
  240. DEBUG_MSG_P(PSTR("[WIFI] Disconnected\n"));
  241. }
  242. // -------------------------------------------------------------------------
  243. if (code == MESSAGE_ACCESSPOINT_CREATING) {
  244. DEBUG_MSG_P(PSTR("[WIFI] Creating access point\n"));
  245. }
  246. if (code == MESSAGE_ACCESSPOINT_CREATED) {
  247. wifiDebug(WIFI_AP);
  248. }
  249. if (code == MESSAGE_ACCESSPOINT_FAILED) {
  250. DEBUG_MSG_P(PSTR("[WIFI] Could not create access point\n"));
  251. }
  252. if (code == MESSAGE_ACCESSPOINT_DESTROYED) {
  253. _wifiUpdateSoftAP();
  254. DEBUG_MSG_P(PSTR("[WIFI] Access point destroyed\n"));
  255. }
  256. // -------------------------------------------------------------------------
  257. if (code == MESSAGE_WPS_START) {
  258. DEBUG_MSG_P(PSTR("[WIFI] WPS started\n"));
  259. }
  260. if (code == MESSAGE_WPS_SUCCESS) {
  261. DEBUG_MSG_P(PSTR("[WIFI] WPS succeded!\n"));
  262. }
  263. if (code == MESSAGE_WPS_ERROR) {
  264. DEBUG_MSG_P(PSTR("[WIFI] WPS failed\n"));
  265. }
  266. // ------------------------------------------------------------------------
  267. if (code == MESSAGE_SMARTCONFIG_START) {
  268. DEBUG_MSG_P(PSTR("[WIFI] Smart Config started\n"));
  269. }
  270. if (code == MESSAGE_SMARTCONFIG_SUCCESS) {
  271. DEBUG_MSG_P(PSTR("[WIFI] Smart Config succeded!\n"));
  272. }
  273. if (code == MESSAGE_SMARTCONFIG_ERROR) {
  274. DEBUG_MSG_P(PSTR("[WIFI] Smart Config failed\n"));
  275. }
  276. }
  277. #endif // DEBUG_SUPPORT
  278. // -----------------------------------------------------------------------------
  279. // SETTINGS
  280. // -----------------------------------------------------------------------------
  281. #if TERMINAL_SUPPORT
  282. void _wifiInitCommands() {
  283. terminalRegisterCommand(F("WIFI"), [](const terminal::CommandContext&) {
  284. wifiDebug();
  285. terminalOK();
  286. });
  287. terminalRegisterCommand(F("WIFI.RESET"), [](const terminal::CommandContext&) {
  288. _wifiConfigure();
  289. wifiDisconnect();
  290. terminalOK();
  291. });
  292. terminalRegisterCommand(F("WIFI.STA"), [](const terminal::CommandContext&) {
  293. wifiStartSTA();
  294. terminalOK();
  295. });
  296. terminalRegisterCommand(F("WIFI.AP"), [](const terminal::CommandContext&) {
  297. wifiStartAP();
  298. terminalOK();
  299. });
  300. #if defined(JUSTWIFI_ENABLE_WPS)
  301. terminalRegisterCommand(F("WIFI.WPS"), [](const terminal::CommandContext&) {
  302. wifiStartWPS();
  303. terminalOK();
  304. });
  305. #endif // defined(JUSTWIFI_ENABLE_WPS)
  306. #if defined(JUSTWIFI_ENABLE_SMARTCONFIG)
  307. terminalRegisterCommand(F("WIFI.SMARTCONFIG"), [](const terminal::CommandContext&) {
  308. wifiStartSmartConfig();
  309. terminalOK();
  310. });
  311. #endif // defined(JUSTWIFI_ENABLE_SMARTCONFIG)
  312. terminalRegisterCommand(F("WIFI.SCAN"), [](const terminal::CommandContext&) {
  313. _wifiScan();
  314. terminalOK();
  315. });
  316. }
  317. #endif
  318. // -----------------------------------------------------------------------------
  319. // WEB
  320. // -----------------------------------------------------------------------------
  321. #if WEB_SUPPORT
  322. bool _wifiWebSocketOnKeyCheck(const char * key, JsonVariant& value) {
  323. if (strncmp(key, "wifi", 4) == 0) return true;
  324. if (strncmp(key, "ssid", 4) == 0) return true;
  325. if (strncmp(key, "pass", 4) == 0) return true;
  326. if (strncmp(key, "ip", 2) == 0) return true;
  327. if (strncmp(key, "gw", 2) == 0) return true;
  328. if (strncmp(key, "mask", 4) == 0) return true;
  329. if (strncmp(key, "dns", 3) == 0) return true;
  330. return false;
  331. }
  332. void _wifiWebSocketOnConnected(JsonObject& root) {
  333. root["wifiScan"] = getSetting("wifiScan", 1 == WIFI_SCAN_NETWORKS);
  334. JsonObject& wifi = root.createNestedObject("wifi");
  335. root["max"] = WIFI_MAX_NETWORKS;
  336. const char* keys[] = {
  337. "ssid", "pass", "ip", "gw", "mask", "dns", "stored"
  338. };
  339. JsonArray& schema = wifi.createNestedArray("schema");
  340. schema.copyFrom(keys, 7);
  341. JsonArray& networks = wifi.createNestedArray("networks");
  342. for (unsigned char index = 0; index < WIFI_MAX_NETWORKS; ++index) {
  343. if (!getSetting({"ssid", index}, _wifiSSID(index)).length()) break;
  344. JsonArray& network = networks.createNestedArray();
  345. network.add(getSetting({"ssid", index}, _wifiSSID(index)));
  346. network.add(getSetting({"pass", index}, _wifiPass(index)));
  347. network.add(getSetting({"ip", index}, _wifiIP(index)));
  348. network.add(getSetting({"gw", index}, _wifiGateway(index)));
  349. network.add(getSetting({"mask", index}, _wifiNetmask(index)));
  350. network.add(getSetting({"dns", index}, _wifiDNS(index)));
  351. network.add(_wifiHasSSID(index));
  352. }
  353. }
  354. void _wifiWebSocketScan(JsonObject& root) {
  355. JsonArray& scanResult = root.createNestedArray("scanResult");
  356. _wifiScan([&scanResult](wifi_scan_info_t& info) {
  357. scanResult.add(info.buffer);
  358. });
  359. }
  360. void _wifiWebSocketOnAction(uint32_t client_id, const char * action, JsonObject& data) {
  361. if (strcmp(action, "scan") == 0) wsPost(client_id, _wifiWebSocketScan);
  362. }
  363. #endif
  364. // -----------------------------------------------------------------------------
  365. // SUPPORT
  366. // -----------------------------------------------------------------------------
  367. #if WIFI_GRATUITOUS_ARP_SUPPORT
  368. // ref: lwip src/core/netif.c netif_issue_reports(...)
  369. // ref: esp-lwip/core/ipv4/etharp.c garp_tmr()
  370. // TODO: only for ipv4, need (?) a different method with ipv6
  371. bool _wifiSendGratuitousArp() {
  372. bool result = false;
  373. for (netif* interface = netif_list; interface != nullptr; interface = interface->next) {
  374. if (
  375. (interface->flags & NETIF_FLAG_ETHARP)
  376. && (interface->hwaddr_len == ETHARP_HWADDR_LEN)
  377. #if LWIP_VERSION_MAJOR == 1
  378. && (!ip_addr_isany(&interface->ip_addr))
  379. #else
  380. && (!ip4_addr_isany_val(*netif_ip4_addr(interface)))
  381. #endif
  382. && (interface->flags & NETIF_FLAG_LINK_UP)
  383. && (interface->flags & NETIF_FLAG_UP)
  384. ) {
  385. etharp_gratuitous(interface);
  386. result = true;
  387. }
  388. }
  389. return result;
  390. }
  391. void _wifiSendGratuitousArp(unsigned long interval) {
  392. if (millis() - _wifi_gratuitous_arp_last > interval) {
  393. _wifi_gratuitous_arp_last = millis();
  394. _wifiSendGratuitousArp();
  395. }
  396. }
  397. #endif // WIFI_GRATUITOUS_ARP_SUPPORT
  398. // -----------------------------------------------------------------------------
  399. // INFO
  400. // -----------------------------------------------------------------------------
  401. // backported WiFiAPClass methods
  402. String _wifiSoftAPSSID() {
  403. struct softap_config config;
  404. wifi_softap_get_config(&config);
  405. char* name = reinterpret_cast<char*>(config.ssid);
  406. char ssid[sizeof(config.ssid) + 1];
  407. memcpy(ssid, name, sizeof(config.ssid));
  408. ssid[sizeof(config.ssid)] = '\0';
  409. return String(ssid);
  410. }
  411. String _wifiSoftAPPSK() {
  412. struct softap_config config;
  413. wifi_softap_get_config(&config);
  414. char* pass = reinterpret_cast<char*>(config.password);
  415. char psk[sizeof(config.password) + 1];
  416. memcpy(psk, pass, sizeof(config.password));
  417. psk[sizeof(config.password)] = '\0';
  418. return String(psk);
  419. }
  420. void wifiDebug(WiFiMode_t modes) {
  421. #if DEBUG_SUPPORT
  422. bool footer = false;
  423. if (((modes & WIFI_STA) > 0) && ((WiFi.getMode() & WIFI_STA) > 0)) {
  424. DEBUG_MSG_P(PSTR("[WIFI] ------------------------------------- MODE STA\n"));
  425. DEBUG_MSG_P(PSTR("[WIFI] SSID %s\n"), WiFi.SSID().c_str());
  426. DEBUG_MSG_P(PSTR("[WIFI] IP %s\n"), WiFi.localIP().toString().c_str());
  427. DEBUG_MSG_P(PSTR("[WIFI] MAC %s\n"), WiFi.macAddress().c_str());
  428. DEBUG_MSG_P(PSTR("[WIFI] GW %s\n"), WiFi.gatewayIP().toString().c_str());
  429. DEBUG_MSG_P(PSTR("[WIFI] DNS %s\n"), WiFi.dnsIP().toString().c_str());
  430. DEBUG_MSG_P(PSTR("[WIFI] MASK %s\n"), WiFi.subnetMask().toString().c_str());
  431. DEBUG_MSG_P(PSTR("[WIFI] HOST http://%s.local\n"), WiFi.hostname().c_str());
  432. DEBUG_MSG_P(PSTR("[WIFI] BSSID %s\n"), WiFi.BSSIDstr().c_str());
  433. DEBUG_MSG_P(PSTR("[WIFI] CH %d\n"), WiFi.channel());
  434. DEBUG_MSG_P(PSTR("[WIFI] RSSI %d\n"), WiFi.RSSI());
  435. footer = true;
  436. }
  437. if (((modes & WIFI_AP) > 0) && ((WiFi.getMode() & WIFI_AP) > 0)) {
  438. DEBUG_MSG_P(PSTR("[WIFI] -------------------------------------- MODE AP\n"));
  439. DEBUG_MSG_P(PSTR("[WIFI] SSID %s\n"), _wifiSoftAPSSID().c_str());
  440. DEBUG_MSG_P(PSTR("[WIFI] PASS %s\n"), _wifiSoftAPPSK().c_str());
  441. DEBUG_MSG_P(PSTR("[WIFI] IP %s\n"), WiFi.softAPIP().toString().c_str());
  442. DEBUG_MSG_P(PSTR("[WIFI] MAC %s\n"), WiFi.softAPmacAddress().c_str());
  443. footer = true;
  444. }
  445. if (WiFi.getMode() == 0) {
  446. DEBUG_MSG_P(PSTR("[WIFI] ------------------------------------- MODE OFF\n"));
  447. DEBUG_MSG_P(PSTR("[WIFI] No connection\n"));
  448. footer = true;
  449. }
  450. if (footer) {
  451. DEBUG_MSG_P(PSTR("[WIFI] ----------------------------------------------\n"));
  452. }
  453. #endif //DEBUG_SUPPORT
  454. }
  455. void wifiDebug() {
  456. wifiDebug(WIFI_AP_STA);
  457. }
  458. // -----------------------------------------------------------------------------
  459. // API
  460. // -----------------------------------------------------------------------------
  461. String getIP() {
  462. if (WiFi.getMode() == WIFI_AP) {
  463. return WiFi.softAPIP().toString();
  464. }
  465. return WiFi.localIP().toString();
  466. }
  467. String getNetwork() {
  468. if (WiFi.getMode() == WIFI_AP) {
  469. return jw.getAPSSID();
  470. }
  471. return WiFi.SSID();
  472. }
  473. bool wifiConnected() {
  474. return jw.connected();
  475. }
  476. void wifiDisconnect() {
  477. jw.disconnect();
  478. }
  479. void wifiStartSTA() {
  480. jw.disconnect();
  481. jw.enableSTA(true);
  482. jw.enableAP(false);
  483. }
  484. void wifiStartAP(bool only) {
  485. if (only) {
  486. jw.enableSTA(false);
  487. jw.disconnect();
  488. jw.resetReconnectTimeout();
  489. }
  490. jw.enableAP(true);
  491. }
  492. void wifiStartAP() {
  493. wifiStartAP(true);
  494. }
  495. #if defined(JUSTWIFI_ENABLE_WPS)
  496. void wifiStartWPS() {
  497. jw.enableAP(false);
  498. jw.disconnect();
  499. jw.startWPS();
  500. }
  501. #endif // defined(JUSTWIFI_ENABLE_WPS)
  502. #if defined(JUSTWIFI_ENABLE_SMARTCONFIG)
  503. void wifiStartSmartConfig() {
  504. jw.enableAP(false);
  505. jw.disconnect();
  506. jw.startSmartConfig();
  507. }
  508. #endif // defined(JUSTWIFI_ENABLE_SMARTCONFIG)
  509. void wifiReconnectCheck() {
  510. bool connected = false;
  511. #if WEB_SUPPORT
  512. if (wsConnected()) connected = true;
  513. #endif
  514. #if TELNET_SUPPORT
  515. if (telnetConnected()) connected = true;
  516. #endif
  517. jw.enableSTA(true);
  518. jw.setReconnectTimeout(connected ? 0 : WIFI_RECONNECT_INTERVAL);
  519. }
  520. uint8_t wifiState() {
  521. uint8_t state = 0;
  522. if (jw.connected()) state += WIFI_STATE_STA;
  523. if (jw.connectable()) state += WIFI_STATE_AP;
  524. if (_wifi_wps_running) state += WIFI_STATE_WPS;
  525. if (_wifi_smartconfig_running) state += WIFI_STATE_SMARTCONFIG;
  526. return state;
  527. }
  528. void wifiRegister(wifi_callback_f callback) {
  529. jw.subscribe(callback);
  530. }
  531. // -----------------------------------------------------------------------------
  532. // INITIALIZATION
  533. // -----------------------------------------------------------------------------
  534. void wifiSetup() {
  535. _wifiConfigure();
  536. #if JUSTWIFI_ENABLE_SMARTCONFIG
  537. if (_wifi_smartconfig_initial) jw.startSmartConfig();
  538. #endif
  539. // Message callbacks
  540. wifiRegister(_wifiCallback);
  541. #if WIFI_AP_CAPTIVE
  542. wifiRegister(_wifiCaptivePortal);
  543. #endif
  544. #if DEBUG_SUPPORT
  545. wifiRegister(_wifiDebugCallback);
  546. #endif
  547. #if WEB_SUPPORT
  548. wsRegister()
  549. .onAction(_wifiWebSocketOnAction)
  550. .onConnected(_wifiWebSocketOnConnected)
  551. .onKeyCheck(_wifiWebSocketOnKeyCheck);
  552. #endif
  553. #if TERMINAL_SUPPORT
  554. _wifiInitCommands();
  555. #endif
  556. // Main callbacks
  557. espurnaRegisterLoop(wifiLoop);
  558. espurnaRegisterReload(_wifiConfigure);
  559. }
  560. void wifiLoop() {
  561. // Main wifi loop
  562. jw.loop();
  563. // Process captrive portal DNS queries if in AP mode only
  564. #if WIFI_AP_CAPTIVE
  565. if ((WiFi.getMode() & WIFI_AP) == WIFI_AP) {
  566. _wifi_dnsServer.processNextRequest();
  567. }
  568. #endif
  569. // Only send out gra arp when in STA mode
  570. #if WIFI_GRATUITOUS_ARP_SUPPORT
  571. if (_wifi_gratuitous_arp_interval) {
  572. _wifiSendGratuitousArp(_wifi_gratuitous_arp_interval);
  573. }
  574. #endif
  575. // Check if we should disable AP
  576. static unsigned long last = 0;
  577. if (millis() - last > 60000) {
  578. last = millis();
  579. _wifiCheckAP();
  580. }
  581. }