Skip to main content
Version: Matrix OS 4.0 🚧

Utils API

Overview​

MatrixOS.Utils exposes low-level helper functions. Most apps do not need this page; prefer the higher-level APIs first.

MatrixOS.Utils.string_hash​

string_hash(text: str) -> int

Returns the same numeric key Matrix OS uses internally for a string.

Parameters:

  • text: Source string.

Returns:

  • int: Matrix OS string hash.

Normal NVS users do not need to call this manually because MatrixOS.NVS.get(...) and MatrixOS.NVS.set(...) accept string keys directly.

Use it only when you need to interoperate with a C++ app or protocol field that already expects the numeric Matrix OS string hash.

import MatrixOS

# Only use this when another API already expects the numeric hash.
key = MatrixOS.Utils.string_hash("HelloPython brightness")
print(key)

Comments