summaryrefslogtreecommitdiff
path: root/shared-bindings/supervisor
diff options
context:
space:
mode:
authordherrada <dylan.herrada@gmail.com>2020-05-12 11:28:33 -0400
committerdherrada <dylan.herrada@gmail.com>2020-05-12 11:28:33 -0400
commit991045b9ce958db9d7102d621f4e7860301e4c21 (patch)
tree2dfbc434cc3c2268ef01c6f7a6389c306f56a973 /shared-bindings/supervisor
parent603df58f971743bc36b9e391cd5fb04812262533 (diff)
Did struct, supervisor, terminalio
Diffstat (limited to 'shared-bindings/supervisor')
-rwxr-xr-xshared-bindings/supervisor/Runtime.c41
-rw-r--r--shared-bindings/supervisor/__init__.c47
2 files changed, 43 insertions, 45 deletions
diff --git a/shared-bindings/supervisor/Runtime.c b/shared-bindings/supervisor/Runtime.c
index 746dfe5ee..05921899c 100755
--- a/shared-bindings/supervisor/Runtime.c
+++ b/shared-bindings/supervisor/Runtime.c
@@ -29,35 +29,35 @@
#include "shared-bindings/supervisor/Runtime.h"
//TODO: add USB, REPL to description once they're operational
-//| .. currentmodule:: supervisor
+//| class Runtime:
+//| """.. currentmodule:: supervisor
//|
-//| :class:`Runtime` --- Supervisor Runtime information
-//| ----------------------------------------------------
+//| :class:`Runtime` --- Supervisor Runtime information
+//| ----------------------------------------------------
//|
-//| Get current status of runtime objects.
+//| Get current status of runtime objects.
//|
-//| Usage::
+//| Usage::
//|
-//| import supervisor
-//| if supervisor.runtime.serial_connected:
-//| print("Hello World!")
+//| import supervisor
+//| if supervisor.runtime.serial_connected:
+//| print("Hello World!")"""
//|
-//| .. class:: Runtime()
-//|
-//| You cannot create an instance of `supervisor.Runtime`.
-//| Use `supervisor.runtime` to access the sole instance available.
+//| def __init__(self, ):
+//| """You cannot create an instance of `supervisor.Runtime`.
+//| Use `supervisor.runtime` to access the sole instance available."""
+//| ...
//|
-//| .. attribute:: runtime.serial_connected
-//|
-//| Returns the USB serial communication status (read-only).
+//| runtime.serial_connected: Any = ...
+//| """Returns the USB serial communication status (read-only).
//|
//| .. note::
//|
//| SAMD: Will return ``True`` if the USB serial connection
//| has been established at any point. Will not reset if
-//| USB is disconnected but power remains (e.g. battery connected)
+//| USB is disconnected but power remains (e.g. battery connected)"""
//|
STATIC mp_obj_t supervisor_get_serial_connected(mp_obj_t self){
@@ -78,11 +78,10 @@ const mp_obj_property_t supervisor_serial_connected_obj = {
};
-//| .. attribute:: runtime.serial_bytes_available
-//|
-//| Returns the whether any bytes are available to read
-//| on the USB serial input. Allows for polling to see whether
-//| to call the built-in input() or wait. (read-only)
+//| runtime.serial_bytes_available: Any = ...
+//| """Returns the whether any bytes are available to read
+//| on the USB serial input. Allows for polling to see whether
+//| to call the built-in input() or wait. (read-only)"""
//|
STATIC mp_obj_t supervisor_get_serial_bytes_available(mp_obj_t self){
if (!common_hal_get_serial_bytes_available()) {
diff --git a/shared-bindings/supervisor/__init__.c b/shared-bindings/supervisor/__init__.c
index 2705c8e58..7fe6668f4 100644
--- a/shared-bindings/supervisor/__init__.c
+++ b/shared-bindings/supervisor/__init__.c
@@ -36,7 +36,7 @@
#include "shared-bindings/supervisor/__init__.h"
#include "shared-bindings/supervisor/Runtime.h"
-//| :mod:`supervisor` --- Supervisor settings
+//| """:mod:`supervisor` --- Supervisor settings
//| =================================================
//|
//| .. module:: supervisor
@@ -50,19 +50,18 @@
//| .. toctree::
//| :maxdepth: 3
//|
-//| Runtime
+//| Runtime"""
//|
-//| .. attribute:: runtime
-//|
-//| Runtime information, such as `runtime.serial_connected`
-//| (USB serial connection status).
-//| This object is the sole instance of `supervisor.Runtime`.
+//| runtime: Any = ...
+//| """Runtime information, such as `runtime.serial_connected`
+//| (USB serial connection status).
+//| This object is the sole instance of `supervisor.Runtime`."""
//|
-//| .. method:: enable_autoreload()
-//|
-//| Enable autoreload based on USB file write activity.
+//| def enable_autoreload(self, ) -> Any:
+//| """Enable autoreload based on USB file write activity."""
+//| ...
//|
STATIC mp_obj_t supervisor_enable_autoreload(void) {
autoreload_enable();
@@ -70,10 +69,10 @@ STATIC mp_obj_t supervisor_enable_autoreload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_enable_autoreload_obj, supervisor_enable_autoreload);
-//| .. method:: disable_autoreload()
-//|
-//| Disable autoreload based on USB file write activity until
-//| `enable_autoreload` is called.
+//| def disable_autoreload(self, ) -> Any:
+//| """Disable autoreload based on USB file write activity until
+//| `enable_autoreload` is called."""
+//| ...
//|
STATIC mp_obj_t supervisor_disable_autoreload(void) {
autoreload_disable();
@@ -81,10 +80,10 @@ STATIC mp_obj_t supervisor_disable_autoreload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_disable_autoreload_obj, supervisor_disable_autoreload);
-//| .. method:: set_rgb_status_brightness()
-//|
-//| Set brightness of status neopixel from 0-255
-//| `set_rgb_status_brightness` is called.
+//| def set_rgb_status_brightness(self, ) -> Any:
+//| """Set brightness of status neopixel from 0-255
+//| `set_rgb_status_brightness` is called."""
+//| ...
//|
STATIC mp_obj_t supervisor_set_rgb_status_brightness(mp_obj_t lvl){
// This must be int. If cast to uint8_t first, will never raise a ValueError.
@@ -97,9 +96,9 @@ STATIC mp_obj_t supervisor_set_rgb_status_brightness(mp_obj_t lvl){
}
MP_DEFINE_CONST_FUN_OBJ_1(supervisor_set_rgb_status_brightness_obj, supervisor_set_rgb_status_brightness);
-//| .. method:: reload()
-//|
-//| Reload the main Python code and run it (equivalent to hitting Ctrl-D at the REPL).
+//| def reload(self, ) -> Any:
+//| """Reload the main Python code and run it (equivalent to hitting Ctrl-D at the REPL)."""
+//| ...
//|
STATIC mp_obj_t supervisor_reload(void) {
reload_requested = true;
@@ -108,9 +107,9 @@ STATIC mp_obj_t supervisor_reload(void) {
}
MP_DEFINE_CONST_FUN_OBJ_0(supervisor_reload_obj, supervisor_reload);
-//| .. method:: set_next_stack_limit(size)
-//|
-//| Set the size of the stack for the next vm run. If its too large, the default will be used.
+//| def set_next_stack_limit(self, size: Any) -> Any:
+//| """Set the size of the stack for the next vm run. If its too large, the default will be used."""
+//| ...
//|
STATIC mp_obj_t supervisor_set_next_stack_limit(mp_obj_t size_obj) {
mp_int_t size = mp_obj_get_int(size_obj);