Exploring UOS in MicroPython

MicroPython is a lean and efficient implementation of the Python 3 programming language that includes a small subset of the Python standard library and is optimized to run on microcontrollers and constrained systems. The uos module in MicroPython is a crucial part of this ecosystem, providing a way to interact with the underlying operating system. This blog post will delve into the fundamental concepts of the uos module, its usage methods, common practices, and best practices to help you make the most of it in your MicroPython projects.

Table of Contents#

  1. Fundamental Concepts of uos in MicroPython
  2. Usage Methods of the uos Module
  3. Common Practices
  4. Best Practices
  5. Conclusion
  6. References

Fundamental Concepts of uos in MicroPython#

The uos module in MicroPython stands for "MicroPython Operating System". It provides a set of functions that allow you to interact with the underlying operating system of the microcontroller or device running MicroPython. This includes operations such as file system management, directory manipulation, and querying system information.

Key Features#

  • File System Operations: You can create, read, write, and delete files and directories on the device's storage.
  • System Information: Get information about the system, such as the current working directory, the list of available files and directories, and the device's unique identifier.
  • Process and Resource Management: Some platforms may support basic process and resource management functions through the uos module.

Usage Methods of the uos Module#

Importing the uos Module#

To use the uos module in your MicroPython code, you need to import it first:

import uos

File System Operations#

Listing Files and Directories#

You can use the uos.listdir() function to list the files and directories in the current working directory:

import uos
 
# List files and directories in the current working directory
files = uos.listdir()
for file in files:
    print(file)

Creating a Directory#

The uos.mkdir() function is used to create a new directory:

import uos
 
# Create a new directory named 'test_dir'
try:
    uos.mkdir('test_dir')
    print("Directory created successfully.")
except OSError:
    print("Directory already exists.")

Deleting a File or Directory#

To delete a file, you can use the uos.remove() function, and to delete a directory, you can use the uos.rmdir() function:

import uos
 
# Delete a file named 'test.txt'
try:
    uos.remove('test.txt')
    print("File deleted successfully.")
except OSError:
    print("File does not exist.")
 
# Delete a directory named 'test_dir'
try:
    uos.rmdir('test_dir')
    print("Directory deleted successfully.")
except OSError:
    print("Directory does not exist or is not empty.")

System Information#

Getting the Current Working Directory#

The uos.getcwd() function returns the current working directory:

import uos
 
# Get the current working directory
cwd = uos.getcwd()
print("Current working directory:", cwd)

Common Practices#

Error Handling#

When performing file system operations, it's important to handle errors properly. For example, if you try to delete a file that doesn't exist, a OSError will be raised. You can use a try-except block to catch and handle these errors gracefully:

import uos
 
try:
    uos.remove('non_existent_file.txt')
except OSError as e:
    print("Error:", e)

Checking if a File or Directory Exists#

Before performing operations on a file or directory, it's a good practice to check if it exists. You can use the uos.stat() function to check if a file or directory exists:

import uos
 
try:
    uos.stat('test.txt')
    print("File exists.")
except OSError:
    print("File does not exist.")

Best Practices#

Resource Management#

When working with files, it's important to close them properly after use to avoid resource leaks. You can use the with statement to ensure that files are automatically closed:

import uos
 
# Write to a file using the with statement
with open('test.txt', 'w') as f:
    f.write('Hello, MicroPython!')
 
# Read from the file using the with statement
with open('test.txt', 'r') as f:
    data = f.read()
    print(data)

Cross - Platform Compatibility#

Keep in mind that the uos module may have some differences in functionality across different MicroPython platforms. Make sure to test your code on the target platform to ensure compatibility.

Conclusion#

The uos module in MicroPython provides a powerful set of functions for interacting with the underlying operating system. By understanding its fundamental concepts, usage methods, common practices, and best practices, you can effectively manage the file system and system resources on your MicroPython device. Whether you're working on a simple data logging project or a more complex embedded system, the uos module can be a valuable tool in your MicroPython toolkit.

References#

2025-10