Skip to content
GitLab
Menu
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
François Revol
firmware
Commits
a4ef1ec0
Commit
a4ef1ec0
authored
Apr 08, 2020
by
schneider
Browse files
doc(config): Add Python docs
parent
1beed7af
Changes
4
Hide whitespace changes
Inline
Side-by-side
Documentation/conf.py
View file @
a4ef1ec0
...
...
@@ -62,6 +62,8 @@ class ColorExample(rst.Directive):
color
=
self
.
arguments
[
0
]
html_text
=
'<div style="width: 30px;height: 30px;background: {};border: black 1px solid;border-radius: 15px;"></div>'
return
[
nodes
.
raw
(
""
,
html_text
.
format
(
color
),
format
=
"html"
)]
# }}}
# -- Options for HTML output ------------------------------------------------- {{{
...
...
@@ -112,6 +114,7 @@ autodoc_mock_imports = [
"sys_display"
,
"sys_leds"
,
"sys_max30001"
,
"sys_config"
,
"ucollections"
,
"urandom"
,
"utime"
,
...
...
Documentation/index.rst
View file @
a4ef1ec0
...
...
@@ -27,6 +27,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/max30001
pycardium/buttons
pycardium/color
pycardium/config
pycardium/display
pycardium/gpio
pycardium/leds
...
...
Documentation/pycardium/config.rst
0 → 100644
View file @
a4ef1ec0
``config`` - Configuration
==========================
The ``config`` module provides functions to interact with card10's
configuration file (``card10.cfg``).
.. automodule:: config
:members:
pycardium/modules/py/config.py
View file @
a4ef1ec0
...
...
@@ -2,8 +2,47 @@ import sys_config
def
set_string
(
key
,
value
):
sys_config
.
set_string
(
key
,
str
(
value
))
"""
Write a string to the configuration file ``card10.cfg``.
Both ``key`` and ``value`` must be strings or must be
convertible to a string using the ``str()`` function.
``key`` must not contain spaces, control characters (including tabs),
number signs ans equal signs.
``value` must not contain control characters (including tabs).
Neither is allowed to contain the sub-string ``execute_elf``.
The key/value pair is immediately written to the configuration
file (``card10.cfg``). After the file is written, configuration
is read again and the new value is available via ``config.get_string``.
:param str key: Name of the configuration option.
:param str value: Value to write.
:raises OSError: If writing to the configuration file failed.
:raises OSError: If key or value contain illegal characters.
:raises ValueError: If key or value contain the sub-string ``execute_elf``.
.. versionadded:: 1.16
"""
sys_config
.
set_string
(
str
(
key
),
str
(
value
))
def
get_string
(
key
):
return
sys_config
.
get_string
(
key
)
"""
Read a string from the configuration file ``card10.cfg``.
``key`` must be a string or must be convertible to a string using
the ``str()`` function.
:param str key: Name of the configuration option.
:rtype: str
:returns: Value of the configuration option.
:raises OSError: if the key is not present in the configuration.
.. versionadded:: 1.16
"""
return
sys_config
.
get_string
(
str
(
key
))
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment