Verified Commit de30bf01 authored by Rahix's avatar Rahix
Browse files

docs(pycardium): Document os module


Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent af4587a9
......@@ -26,6 +26,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/display
pycardium/leds
pycardium/light-sensor
pycardium/os
pycardium/utime
pycardium/vibra
......
.. py:module:: os
``os`` - OS Functions
=====================
The ``os`` module allows access to a few core functionalities of Epicardium and functions found in CPythons ``os`` module.
CPython-Like
------------
.. py:function:: os.unlink(path)
Unlink (remove) a file.
:param str path: The file to remove.
.. py:function:: os.listdir(dir)
List contents of a directory.
:param str dir: Path to the directory to list.
:returns: A list of entities (files or subdirectories) in the directory
``dir``.
Epicardium-Specific
-------------------
.. py:function:: os.exit(ret = None)
Exit from the current app and return to the menu.
:param int ret: Optional return code, same semantics as Posix (``0`` means
success).
:return: This function will never return.
.. py:function:: os.exec(name)
Try executing a new app, stopping the currently running one.
``name`` is the path to either a l0dable (ending in ``.elf``) or a python
script (ending in ``.py``). If the path does not lead to an executable file,
``os.exec()`` will raise an exception.
:param str name: Path to new app/script/l0dable.
:return: This function never returns. It can, however raise an exception.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment