diff options
| author | Peter Hinch | 2016-01-11 06:48:35 +0000 |
|---|---|---|
| committer | Damien George | 2016-01-13 21:53:26 +0000 |
| commit | c13b2f2d0040cdf38ea3178717480d07f02c5245 (patch) | |
| tree | a6d17950ffc505f19f565f7f0b8313dc2246cc60 /docs/library | |
| parent | 22d85ec5be77e7ee6b703221d51113f7f21a995b (diff) | |
docs: Several minor changes: network, pyb, ADCAll and inline asm.
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/network.rst | 3 | ||||
| -rw-r--r-- | docs/library/pyb.ADC.rst | 6 | ||||
| -rw-r--r-- | docs/library/pyb.rst | 8 |
3 files changed, 16 insertions, 1 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst index 272d8dcb3..11e7a2a41 100644 --- a/docs/library/network.rst +++ b/docs/library/network.rst @@ -8,7 +8,8 @@ This module provides network drivers and routing configuration. Network drivers for specific hardware are available within this module and are used to configure a hardware network interface. Configured interfaces -are then available for use via the :mod:`socket` module. +are then available for use via the :mod:`socket` module. To use this module +the network build of firmware must be installed. For example:: diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst index af4dc3d77..42f491eec 100644 --- a/docs/library/pyb.ADC.rst +++ b/docs/library/pyb.ADC.rst @@ -74,3 +74,9 @@ Methods This function does not allocate any memory. +The ADCAll Object +----------------- + +Instantiating this changes all ADC pins to analog inputs. It is possible to read the +MCU temperature, VREF and VBAT without using ADCAll. The raw data can be accessed on +ADC channels 16, 17 and 18 respectively. However appropriate scaling will need to be applied. diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst index 546e7e578..7be39a5d8 100644 --- a/docs/library/pyb.rst +++ b/docs/library/pyb.rst @@ -25,6 +25,10 @@ Time related functions after 2^30 milliseconds (about 12.4 days) this will start to return negative numbers. + Note that if :meth:`pyb.stop()` is issued the hardware counter supporting this + function will pause for the duration of the "sleeping" state. This + will affect the outcome of :meth:`pyb.elapsed_millis()`. + .. function:: micros() Returns the number of microseconds since the board was last reset. @@ -33,6 +37,10 @@ Time related functions after 2^30 microseconds (about 17.8 minutes) this will start to return negative numbers. + Note that if :meth:`pyb.stop()` is issued the hardware counter supporting this + function will pause for the duration of the "sleeping" state. This + will affect the outcome of :meth:`pyb.elapsed_micros()`. + .. function:: elapsed_millis(start) Returns the number of milliseconds which have elapsed since ``start``. |