diff --git a/Documentation/index.rst b/Documentation/index.rst index 28fb426c638522d1b47f34bd88f17ababecfebf6..27b0d56a65f88b320cc3e83c83a86014a006ee5a 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -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 diff --git a/Documentation/pycardium/os.rst b/Documentation/pycardium/os.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b450fd38e655712d9999d228900a30ad3d17087 --- /dev/null +++ b/Documentation/pycardium/os.rst @@ -0,0 +1,45 @@ +.. 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.