mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/uos.rst

103 lines
2.2 KiB
ReStructuredText
Raw Normal View History

docs/library: "os" module is actually "uos".
2016-04-26 23:55:06 +01:00
:mod:`uos` -- basic "operating system" services
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
==============================================
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs/library: "os" module is actually "uos".
2016-04-26 23:55:06 +01:00
.. module:: uos
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
:synopsis: basic "operating system" services
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 18:32:02 +01:00
The ``os`` module contains functions for filesystem access and ``urandom``
function.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 18:32:02 +01:00
Port specifics
--------------
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs/os: Change wording to be a bit more port-neutral.
2016-04-03 18:32:02 +01:00
The filesystem has ``/`` as the root directory and the
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
available physical drives are accessible from here. They are currently:
``/flash`` -- the internal flash filesystem
``/sd`` -- the SD card (if it exists)
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
.. only:: port_pyboard
On boot up, the current directory is ``/flash`` if no SD card is inserted,
otherwise it is ``/sd``.
.. only:: port_wipy
On boot up, the current directory is ``/flash``.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Functions
---------
.. function:: chdir(path)
Change current directory.
.. function:: getcwd()
Get the current directory.
.. function:: listdir([dir])
With no argument, list the current directory. Otherwise list the given directory.
.. function:: mkdir(path)
Create a new directory.
.. function:: remove(path)
Remove a file.
.. function:: rmdir(path)
Remove a directory.
stmhal: Add os.rename function.
2015-05-11 01:30:56 +01:00
.. function:: rename(old_path, new_path)
Rename a file.
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
.. function:: stat(path)
Get the status of a file or directory.
.. function:: sync()
Sync all filesystems.
.. function:: urandom(n)
Return a bytes object with n random bytes, generated by the hardware
random number generator.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
.. only:: port_wipy
docs: Update all WiPy docs to reflect the new API.
2015-10-14 11:32:01 +01:00
.. function:: mount(block_device, mount_point, \*, readonly=False)
Mounts a block device (like an ``SD`` object) in the specified mount
point. Example::
os.mount(sd, '/sd')
.. function:: unmount(path)
Unmounts a prevoulsy mounted block device from the given path.
.. function:: mkfs(block_device or path)
Formats the specified path, must be either ``/flash`` or ``/sd``.
A block device can also be passed like an ``SD`` object before
being mounted.
.. function:: dupterm(stream_object)
Duplicate the terminal (the REPL) on the passed stream-like object.
The given object must at least implement the ``.read()`` and ``.write()`` methods.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 22:29:56 +01:00
docs: Import documentation from source-code inline comments. The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Constants
---------
.. data:: sep
separation character used in paths