aboutsummaryrefslogtreecommitdiff
path: root/docs/library/network.rst
AgeCommit message (Collapse)Author
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
2020-06-05docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.David Lechner
This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2018-09-27docs/library/network: Make AbstractNIC methods layout correctly.Damien George
2018-09-27docs/library/network: Move specific network classes to their own file.Damien George
All concrete network classes are now moved to their own file (eg network.WLAN.rst) and deconditionalised (remove ..only:: directives). This makes the network documentation the same for all ports. After this change there are no more "..only::" directives for different ports, and the only difference among ports is the very front page of the docs.
2018-02-26esp8266/modnetwork: Implement WLAN.status('rssi') for STA interface.Damien George
This will return the RSSI of the AP that the STA is connected to.
2017-11-16docs/library/network: Enhance AbstractNIC.status to take an argument.Damien George
The argument is optional and if given should be a string naming the status variable to query.
2017-10-27docs/library/network: Add dhcp_hostname parameterJoar Wandborg
I have not actually tested this, going by information available in https://forum.micropython.org/viewtopic.php?t=2584
2017-10-16docs/library/network: Update docs to state that W5500 is supported.Damien George
2017-10-16stm32/modnwwiznet5k: Implement WIZNET5K.isconnected() method.Damien George
2017-10-09docs/library/network: Clarify usage of "bssid" arg in connect() method.Damien George
2017-08-28docs/library/network: Fix ref to "socket" module (should be "usocket").Paul Sokolovsky
2017-08-28docs: More xrefs to "MicroPython port" in glossary.Paul Sokolovsky
2017-06-26docs/network: Use markup adhering to the latest docs conventions.Paul Sokolovsky
2017-06-04docs/network: First step to describe standard network class interface.Paul Sokolovsky
This adds description of implied AbstractNIC base class, which should be "subclasses" and implemented by a particular network device class. This is just an initial step in that direction, the API and description will be elabotated further.
2017-06-03docs/network: Move confusingly-named cc3200 Server class to its reference.Paul Sokolovsky
cc3200 port has network.Server class to control behavior of builtin Telnet/FTP server of that port.
2016-10-28docs/library/network: Typo fixes, consistent acronym capitalization.Paul Sokolovsky
2016-10-28docs/library/network: Reword intro paragraph.Paul Sokolovsky
2016-08-02docs: Spelling mistakesMike Causer
2016-06-07docs/library/network: wipy: Fix literal block indentation.Paul Sokolovsky
2016-05-03docs/network: esp8266: MAC address is set via .config() method.Paul Sokolovsky
2016-04-28docs/network: esp8266: Describe wlan.config() method.Paul Sokolovsky
2016-04-28docs/network: esp8266: Add wlan.ifconfig() method.Paul Sokolovsky
2016-04-26docs/network: esp8266: scan(): Add note that bssid is bytes object.Paul Sokolovsky
2016-03-30docs: network: esp8266: .scan() is now synchronous and returns result list.Paul Sokolovsky
2016-03-30docs: network: esp8266: status is WLAN object method.Paul Sokolovsky
2016-03-27docs/esp8266: esp.mac() replaced with network.WLAN.mac().Paul Sokolovsky
2016-03-27docs/esp8266: esp.wifi_mode() replaced with network.WLAN.active().Paul Sokolovsky
2016-03-27docs/esp8266: phy_mode() moved to network module.Paul Sokolovsky
2016-03-25docs/network: esp8266: Update docs on WLAN constructor.Paul Sokolovsky
2016-02-22cc3200: Rename 'server' class to 'Server' for consistency.danicampora
2016-01-13docs: Several minor changes: network, pyb, ADCAll and inline asm.Peter Hinch
2015-12-16docs/library: Add network server example.danicampora
2015-11-18docs: Update docs for WiPy wlan.connect().Noah
- The link establishment timeout is infinite by default - Fix typo in notes about the auth kwarg
2015-10-22docs: Fix typos on wipy docs.danicampora
2015-10-21docs: Several corrections to the classes in the machine module.danicampora
2015-10-21docs: Add usocket and ussl modules' documentation.danicampora
2015-10-19cc3200: WLAN class can retrieve the existing instance.danicampora
2015-10-19docs/wipy: Add wipy tutorials section.danicampora
2015-10-19docs: Add wipy and network.server documentation.danicampora
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora
2015-10-06docs: Update esp8266 documentation to match the code.Radomir Dopieralski
* Move the esp.status() to network module. * Describe the wifi.isconnected() method. * Describe esp.mac(), esp.wifi_mode(), esp.phy_mode(), esp.sleep_type(), esp.deepsleep(), and esp.flash_id() functions.
2015-08-16cc3200: Improve callback API.Daniel Campora
Rename "wakes" param to "wake_from" and make "value" an object instead of an integer.
2015-08-09cc3200: Improve support for WEP security.Daniel Campora
Key is always entered as a string, but if security is WEP, the key is converted automatically to hex before connecting or configuring the device as an AP.
2015-08-09cc3200: Add nic.iwconfig() to set/get WLAN configuration.Daniel Campora
Changes are based on this post: https://github.com/micropython/micropython/issues/876#issuecomment-115255551 The constructor can optionally take the same params of iwconfig in order to configure WiFi when creating the object. Params are keyworkd only. The WiPy accepts: - mode (int -> WLAN.AP or WLAN.STA) - ssdi (string) - security (int -> WLAN.OPEN, WLAN.WEP, WLAN.WPA, WLAN.WPA2) - key (string) - channel (int (1-11)) - antenna (int -> WLAN.INTERNAL, WLAN.EXTERNAL)
2015-06-27docs: Fix duplicate label error for network.WLAN.Damien George
2015-06-17esp8266: Updated documentation for scan() and moved to networkBill Owens
2015-06-13esp8266: Fix the documentation for esp.connect() and esp.disconnect()Radomir Dopieralski
Since the commit that moved those two functions failed to update the documentation, this is a fix for that.
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2014-12-04docs: Update network docs to reflect changes to code.Damien George