From e3f153bd8540e46db1761f7f5c27d0a66ea3fff6 Mon Sep 17 00:00:00 2001 From: Nathanne Isip Date: Wed, 31 Jul 2024 03:18:02 +0800 Subject: [PATCH] Updated documentation pages. --- docs/annotated.html | 33 +- docs/classes.html | 21 +- docs/d0/d13/wifi_8h_source.html | 155 +++ docs/d0/dab/classGpio-members.html | 21 +- docs/d1/d56/classIO-members.html | 21 +- docs/d1/d61/classSys.html | 107 +- docs/d1/d72/classSys-members.html | 21 +- docs/d2/dbe/classNVS-members.html | 21 +- docs/d3/d51/runtime_8h.html | 25 +- docs/d3/d51/runtime_8h_source.html | 34 +- docs/d3/d7e/int_8h.html | 37 +- docs/d3/d7e/int_8h_source.html | 50 +- docs/d4/d67/classArgs-members.html | 21 +- docs/d4/d68/display_8h.html | 25 +- docs/d4/d68/display_8h_source.html | 42 +- docs/d4/d79/classGpio.html | 115 +- docs/d4/d9a/classFS-members.html | 21 +- docs/d4/dbc/group__Rishka__SDK.html | 27 +- docs/d5/d52/classI2C-members.html | 21 +- docs/d5/daf/i2c_8h.html | 25 +- docs/d5/daf/i2c_8h_source.html | 78 +- docs/d6/d61/classMemory-members.html | 21 +- docs/d6/d7c/gpio_8h.html | 47 +- docs/d6/d7c/gpio_8h_source.html | 78 +- docs/d6/d81/classI2C.html | 179 +-- docs/d6/da0/keyboard_8h.html | 25 +- docs/d6/da0/keyboard_8h_source.html | 62 +- docs/d6/db5/rt_syscalls.html | 220 ++-- docs/d6/dd6/classDisplay.html | 57 +- docs/d6/dd8/classRuntime.html | 43 +- docs/d6/de4/librishka_8h.html | 25 +- docs/d6/de4/librishka_8h_source.html | 26 +- docs/d6/df3/classFS.html | 59 +- docs/d7/dde/devices_8h.html | 47 +- docs/d7/dde/devices_8h_source.html | 44 +- docs/d8/d2f/classInt.html | 59 +- docs/d8/d66/classIO.html | 181 +-- docs/d8/d88/classKeyboard-members.html | 21 +- docs/d8/dfa/classRuntime-members.html | 21 +- docs/d9/d49/types_8h.html | 57 +- docs/d9/d49/types_8h_source.html | 50 +- docs/d9/d87/sys_8h.html | 101 +- docs/d9/d87/sys_8h_source.html | 126 +- docs/da/dc6/classMemory.html | 69 +- docs/db/d08/classInt-members.html | 21 +- docs/db/d30/classFile.html | 209 ++-- docs/db/d77/args_8h.html | 25 +- docs/db/d77/args_8h_source.html | 36 +- docs/dc/d18/memory_8h.html | 25 +- docs/dc/d18/memory_8h_source.html | 44 +- docs/dc/d54/func__args_8h.html | 57 +- docs/dc/d54/func__args_8h_source.html | 28 +- docs/dc/da5/librishka__impl_8hpp_source.html | 234 ++-- docs/dc/dac/io_8h.html | 107 +- docs/dc/dac/io_8h_source.html | 142 +-- docs/dc/dd2/classKeyboard.html | 131 ++- docs/dd/d66/classDisplay-members.html | 21 +- docs/dd/d99/nvs_8h.html | 25 +- docs/dd/d99/nvs_8h_source.html | 94 +- docs/dd/dfa/classArgs.html | 43 +- docs/de/daf/group__Rishka__Drivers__SDK.html | 27 +- docs/df/d26/fs_8h.html | 25 +- docs/df/d26/fs_8h_source.html | 97 +- docs/df/d31/classFile-members.html | 21 +- docs/df/dbb/classNVS.html | 171 +-- .../dir_167427595296cdae7b26c53f264640fa.html | 21 +- .../dir_243a4ba6b4f893d71afbb5a3e90552fa.html | 27 +- .../dir_6e8afc538eccbcb491711fd0cc7b9703.html | 47 +- .../dir_a52f4d3d586a58b02f3a4ddf0a992157.html | 21 +- .../dir_de5940d52a2b3ecb9d04406b778a15dd.html | 29 +- docs/dir_de5940d52a2b3ecb9d04406b778a15dd.js | 3 +- docs/doxygen.css | 1024 ++++++++++------- docs/doxygen.svg | 4 +- docs/dynsections.js | 71 ++ docs/files.html | 56 +- docs/functions.html | 21 +- docs/functions_func.html | 23 +- docs/globals.html | 21 +- docs/globals_defs.html | 23 +- docs/globals_enum.html | 23 +- docs/globals_eval.html | 23 +- docs/globals_type.html | 23 +- docs/index.html | 61 +- docs/jquery.js | 7 +- docs/menu.js | 33 +- docs/menudata.js | 2 +- docs/navtree.css | 22 +- docs/navtree.js | 28 +- docs/navtreedata.js | 4 +- docs/navtreeindex0.js | 9 +- docs/pages.html | 23 +- docs/resize.js | 81 +- docs/search/all_1.js | 3 +- docs/search/all_10.js | 106 +- docs/search/all_11.js | 5 +- docs/search/all_12.js | 3 +- docs/search/all_13.js | 3 +- docs/search/all_14.js | 5 +- docs/search/all_2.js | 16 +- docs/search/all_3.js | 5 +- docs/search/all_4.js | 6 +- docs/search/all_5.js | 2 +- docs/search/all_7.js | 3 +- docs/search/all_8.js | 30 +- docs/search/all_a.js | 4 +- docs/search/all_b.js | 11 +- docs/search/all_d.js | 7 +- docs/search/all_f.js | 33 +- docs/search/close.svg | 19 +- docs/search/groups_0.js | 3 +- docs/search/groups_1.js | 3 +- docs/search/groups_2.js | 4 + docs/search/mag_sel.svg | 53 +- docs/search/pages_0.js | 3 +- docs/search/search.css | 110 +- docs/search/search.js | 144 ++- docs/search/searchdata.js | 4 +- docs/tabs.css | 2 +- docs/topics.html | 16 +- docs/topics.js | 2 +- 120 files changed, 3794 insertions(+), 2663 deletions(-) create mode 100644 docs/d0/d13/wifi_8h_source.html create mode 100644 docs/search/groups_2.js diff --git a/docs/annotated.html b/docs/annotated.html index 5893737..4f60f67 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -1,9 +1,9 @@ - + - + Rishka: Class List @@ -36,10 +36,10 @@ - + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -91,17 +98,17 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
- + - + - + - + - + - +
 CArgsClass for handling command line arguments in Rishka applications
 CDisplayFinal class to interact with display hardware
 CDisplayFinal class to interact with display hardware
 CFileClass for handling file operations in Rishka applications
 CFSClass for file system operations in Rishka applications
 CFSClass for file system operations in Rishka applications
 CGpioClass for handling GPIO operations in Rishka applications
 CI2CClass for handling I2C operations in Rishka applications
 CI2CClass for handling I2C operations in Rishka applications
 CIntClass for handling interrupt operations in Rishka applications
 CIOClass for handling input/output operations in Rishka applications
 CIOClass for handling input/output operations in Rishka applications
 CKeyboardProvides access to keyboard-related functionalities in the Rishka VM SDK
 CMemoryClass for handling memory management operations in Rishka applications
 CMemoryClass for handling memory management operations in Rishka applications
 CNVSProvides an interface to the non-volatile storage (NVS) in the Rishka system
 CRuntimeUtilities for managing runtime operations
 CRuntimeUtilities for managing runtime operations
 CSysClass for handling system utilities in Rishka applications
diff --git a/docs/classes.html b/docs/classes.html index 4b7e81e..55567d5 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -1,9 +1,9 @@ - + - + Rishka: Class Index @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d0/d13/wifi_8h_source.html b/docs/d0/d13/wifi_8h_source.html new file mode 100644 index 0000000..3180b14 --- /dev/null +++ b/docs/d0/d13/wifi_8h_source.html @@ -0,0 +1,155 @@ + + + + + + + +Rishka: sdk/librishka/drivers/wifi.h Source File + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Rishka +
+
RISC-V virtual runtime in C/C++ made for ESP32-WROVER
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
wifi.h
+
+
+
1#ifndef LIBRISHKA_DRIVERS_WIFI_H
+
2#define LIBRISHKA_DRIVERS_WIFI_H
+
3
+
4#include <librishka.h>
+
5#include <librishka/types.h>
+
6
+
7typedef enum {
+
8 WIFI_AUTH_OPEN = 0x00,
+
9 WIFI_AUTH_WEP,
+
10 WIFI_AUTH_WPA_PSK,
+
11 WIFI_AUTH_WPA2_PSK,
+
12 WIFI_AUTH_WPA_WPA2_PSK,
+
13 WIFI_AUTH_ENTERPRISE,
+
14 WIFI_AUTH_WPA2_ENTERPRISE = 0x05,
+
15 WIFI_AUTH_WPA3_PSK,
+
16 WIFI_AUTH_WPA2_WPA3_PSK,
+
17 WIFI_AUTH_WAPI_PSK,
+
18 WIFI_AUTH_WPA3_ENT_192,
+
19 WIFI_AUTH_MAX
+
20} WiFiAuthMode;
+
21
+
22typedef enum {
+
23 WIFI_FAST_SCAN = 0x00,
+
24 WIFI_ALL_CHANNEL_SCAN = 0x01
+
25} WiFiScanMethod;
+
26
+
27typedef enum {
+
28 WIFI_CONNECT_AP_BY_SIGNAL = 0,
+
29 WIFI_CONNECT_AP_BY_SECURITY,
+
30} WiFiSortMethod;
+
31
+
32typedef enum {
+
33 WIFI_STATUS_NO_SHIELD = 0xff,
+
34 WIFI_STATUS_STOPPED = 0xfe,
+
35 WIFI_STATUS_IDLE_STATUS = 0x00,
+
36 WIFI_STATUS_NO_SSID_AVAIL = 0x01,
+
37 WIFI_STATUS_SCAN_COMPLETED = 0x02,
+
38 WIFI_STATUS_CONNECTED = 0x03,
+
39 WIFI_STATUS_CONNECT_FAILED = 0x04,
+
40 WIFI_STATUS_CONNECTION_LOST = 0x05,
+
41 WIFI_STATUS_DISCONNECTED = 0x06
+
42} WiFiStatus;
+
43
+
44#endif
+
librishka.h
Main header file for the Rishka SDK.
+
types.h
Header file for common data types used in Rishka applications.
+
+
+ \ No newline at end of file diff --git a/docs/d0/dab/classGpio-members.html b/docs/d0/dab/classGpio-members.html index 5a1cce1..f2ca176 100644 --- a/docs/d0/dab/classGpio-members.html +++ b/docs/d0/dab/classGpio-members.html @@ -1,9 +1,9 @@ - + - + Rishka: Member List @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d1/d56/classIO-members.html b/docs/d1/d56/classIO-members.html index aea1fde..2b7698f 100644 --- a/docs/d1/d56/classIO-members.html +++ b/docs/d1/d56/classIO-members.html @@ -1,9 +1,9 @@ - + - + Rishka: Member List @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d1/d61/classSys.html b/docs/d1/d61/classSys.html index d427f8c..7f404e9 100644 --- a/docs/d1/d61/classSys.html +++ b/docs/d1/d61/classSys.html @@ -1,9 +1,9 @@ - + - + Rishka: Sys Class Reference @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -99,43 +106,43 @@ - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

Static Public Member Functions

static void delay (u64 ms)
 Delay execution for a specified duration. More...
static void delay (u64 ms)
 Delay execution for a specified duration.
 
static u64 micros ()
 Get the current system time in microseconds. More...
static u64 micros ()
 Get the current system time in microseconds.
 
static u64 millis ()
 Get the current system time in milliseconds. More...
static u64 millis ()
 Get the current system time in milliseconds.
 
static i64 shellexec (string cmdline)
 Execute a shell command. More...
static i64 shellexec (string cmdline)
 Execute a shell command.
 
static void exit (i32 code)
 Terminate the application with an exit code. More...
static void exit (i32 code)
 Terminate the application with an exit code.
 
static string info_str (sysinfos_t key)
 Get system information as a string. More...
static string info_str (sysinfos_t key)
 Get system information as a string.
 
static i64 info_num (sysinfon_t key)
 Get system information as a numeric value. More...
static i64 info_num (sysinfon_t key)
 Get system information as a numeric value.
 
static i64 random ()
 Generate a random integer value. More...
static i64 random ()
 Generate a random integer value.
 
static bool change_dir (char *directory)
 Changes the current working directory. More...
static bool change_dir (char *directory)
 Changes the current working directory.
 
static string working_dir ()
 Retrieves the current working directory. More...
static string working_dir ()
 Retrieves the current working directory.
 

Detailed Description

-

Class for handling system utilities in Rishka applications.

-

The Sys class provides static methods for delaying execution, accessing system time, executing shell commands, retrieving system information, and exiting the application.

+

Class for handling system utilities in Rishka applications.

+

The Sys class provides static methods for delaying execution, accessing system time, executing shell commands, retrieving system information, and exiting the application.

Member Function Documentation

-

◆ change_dir()

+

◆ change_dir()

@@ -159,7 +166,7 @@

Changes the current working directory.

-

This static method changes the current working directory to the specified directory.

+

This static method changes the current working directory to the specified directory.

Parameters
@@ -171,7 +178,7 @@

-

◆ delay()

+

◆ delay()

@@ -195,7 +202,7 @@

Delay execution for a specified duration.

-

This method suspends program execution for the specified number of milliseconds.

+

This method suspends program execution for the specified number of milliseconds.

Parameters

directoryThe directory to change to.
@@ -206,7 +213,7 @@

-

◆ exit()

+

◆ exit()

@@ -230,7 +237,7 @@

Terminate the application with an exit code.

-

This method terminates the application with the specified exit code.

+

This method terminates the application with the specified exit code.

Parameters

msThe duration to delay in milliseconds.
@@ -241,7 +248,7 @@

-

◆ info_num()

+

◆ info_num()

@@ -265,7 +272,7 @@

Get system information as a numeric value.

-

This method retrieves system information specified by the key as a numeric value.

+

This method retrieves system information specified by the key as a numeric value.

Parameters

codeThe exit code for the application.
@@ -277,7 +284,7 @@

-

◆ info_str()

+

◆ info_str()

@@ -301,7 +308,7 @@

Get system information as a string.

-

This method retrieves system information specified by the key as a string representation.

+

This method retrieves system information specified by the key as a string representation.

Parameters

keyThe key for the system information.
@@ -313,7 +320,7 @@

-

◆ micros()

+

◆ micros()

@@ -336,13 +343,13 @@

Get the current system time in microseconds.

-

This method returns the current system time in microseconds since boot.

+

This method returns the current system time in microseconds since boot.

Returns
The current system time in microseconds.

-

◆ millis()

+

◆ millis()

@@ -365,13 +372,13 @@

Get the current system time in milliseconds.

-

This method returns the current system time in milliseconds since boot.

+

This method returns the current system time in milliseconds since boot.

Returns
The current system time in milliseconds.

-

◆ random()

+

◆ random()

@@ -394,13 +401,13 @@

Generate a random integer value.

-

The random() function generates a random integer value within the range supported by the underlying hardware's random number generator. The generated random value is suitable for various applications such as cryptographic operations, simulation, and randomization tasks.

+

The random() function generates a random integer value within the range supported by the underlying hardware's random number generator. The generated random value is suitable for various applications such as cryptographic operations, simulation, and randomization tasks.

Returns
A random integer value within the supported range.

-

◆ shellexec()

+

◆ shellexec()

@@ -424,7 +431,7 @@

Execute a shell command.

-

This method executes a shell command with the specified binary program file name, argument count, and argument array.

+

This method executes a shell command with the specified binary program file name, argument count, and argument array.

Parameters

keyThe key for the system information.
@@ -438,7 +445,7 @@

-

◆ working_dir()

+

◆ working_dir()

@@ -461,14 +468,14 @@

Retrieves the current working directory.

-

This static method returns the current working directory as a string.

+

This static method returns the current working directory as a string.

Returns
A string representing the current working directory.

The documentation for this class was generated from the following files: diff --git a/docs/d1/d72/classSys-members.html b/docs/d1/d72/classSys-members.html index b81260a..6db4a27 100644 --- a/docs/d1/d72/classSys-members.html +++ b/docs/d1/d72/classSys-members.html @@ -1,9 +1,9 @@ - + - +Rishka: Member List @@ -36,10 +36,10 @@
programThe file name of the binary program to execute.

- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d2/dbe/classNVS-members.html b/docs/d2/dbe/classNVS-members.html index c18646b..e69b3be 100644 --- a/docs/d2/dbe/classNVS-members.html +++ b/docs/d2/dbe/classNVS-members.html @@ -1,9 +1,9 @@ - + - + Rishka: Member List @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d3/d51/runtime_8h.html b/docs/d3/d51/runtime_8h.html index 22fe7c2..d7e557a 100644 --- a/docs/d3/d51/runtime_8h.html +++ b/docs/d3/d51/runtime_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/runtime.h File Reference @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -103,8 +110,8 @@  

Detailed Description

-

Provides utilities for managing runtime operations within Rishka applications.

-
Author
Nathanne Isip
+

Provides utilities for managing runtime operations within Rishka applications.

+
Author
Nathanne Isip

The Runtime class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management.

diff --git a/docs/d3/d51/runtime_8h_source.html b/docs/d3/d51/runtime_8h_source.html index 2ff84d8..a2aa95f 100644 --- a/docs/d3/d51/runtime_8h_source.html +++ b/docs/d3/d51/runtime_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/runtime.h Source File @@ -36,10 +36,10 @@
- + @@ -53,6 +53,11 @@ /* @license-end */ +
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -106,7 +113,7 @@ - @@ -114,12 +121,12 @@

Enumerations

enum  int_mode_t { INT_CHANGE = 0x1 +
enum  int_mode_t { INT_CHANGE = 0x1 , INT_FAILING = 0x2 , INT_RISING = 0x3 }
 

Detailed Description

-

Header file for interrupt handling in Rishka applications.

-
Author
Nathanne Isip
+

Header file for interrupt handling in Rishka applications.

+
Author
Nathanne Isip

This header file defines the Int class, which provides functionalities for managing interrupts on ESP32-WROVER microcontrollers.

Enumeration Type Documentation

-

◆ int_mode_t

+

◆ int_mode_t

@@ -131,17 +138,17 @@

Enum representing interrupt modes for GPIO pins.

-

This enum specifies the interrupt modes available for configuring GPIO pin interrupts.

    +

    This enum specifies the interrupt modes available for configuring GPIO pin interrupts.

    • INT_CHANGE: Interrupt triggered on pin state change.
    • INT_FAILING: Interrupt triggered on falling edge.
    • INT_RISING: Interrupt triggered on rising edge.
    - - -
    Enumerator
    INT_CHANGE 

    Interrupt triggered on pin state change

    +
    Enumerator
    INT_CHANGE 

    Interrupt triggered on pin state change

    INT_FAILING 

    Interrupt triggered on falling edge

    +
    INT_FAILING 

    Interrupt triggered on falling edge

    INT_RISING 

    Interrupt triggered on rising edge

    +
    INT_RISING 

    Interrupt triggered on rising edge

    diff --git a/docs/d3/d7e/int_8h_source.html b/docs/d3/d7e/int_8h_source.html index 35edf73..e4cb377 100644 --- a/docs/d3/d7e/int_8h_source.html +++ b/docs/d3/d7e/int_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/int.h Source File @@ -36,10 +36,10 @@

- + @@ -53,6 +53,11 @@ /* @license-end */ +
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
diff --git a/docs/d4/d68/display_8h.html b/docs/d4/d68/display_8h.html index d67ffa0..0218e7b 100644 --- a/docs/d4/d68/display_8h.html +++ b/docs/d4/d68/display_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/drivers/display.h File Reference @@ -36,10 +36,10 @@
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -104,8 +111,8 @@  

Detailed Description

-

Provides an interface for interacting with display hardware in the Rishka SDK.

-
Author
Nathanne Isip
+

Provides an interface for interacting with display hardware in the Rishka SDK.

+
Author
Nathanne Isip

The Display class offers a set of static methods to retrieve various properties of the display hardware. This includes methods to get the dimensions of the screen and viewport, as well as the number of supported colors. By using this class, developers can easily obtain necessary information about the display to tailor their applications accordingly.

diff --git a/docs/d4/d68/display_8h_source.html b/docs/d4/d68/display_8h_source.html index 244006b..cf2ac3d 100644 --- a/docs/d4/d68/display_8h_source.html +++ b/docs/d4/d68/display_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/drivers/display.h Source File @@ -36,10 +36,10 @@
- + @@ -53,6 +53,11 @@ /* @license-end */ +
- + @@ -79,9 +79,16 @@
- +
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
@@ -99,46 +106,46 @@ - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

Static Public Member Functions

static void pin_mode (u8 pin, gpio_pin_mode_t mode)
 Set the mode of a GPIO pin. More...
static void pin_mode (u8 pin, gpio_pin_mode_t mode)
 Set the mode of a GPIO pin.
 
static gpio_mode_t digital_read (u8 pin)
 Read the digital value of a GPIO pin. More...
static gpio_mode_t digital_read (u8 pin)
 Read the digital value of a GPIO pin.
 
static void digital_write (u8 pin, gpio_mode_t mode)
 Write a digital value to a GPIO pin. More...
static void digital_write (u8 pin, gpio_mode_t mode)
 Write a digital value to a GPIO pin.
 
static u16 analog_read (u8 pin)
 Read the analog value of a GPIO pin. More...
static u16 analog_read (u8 pin)
 Read the analog value of a GPIO pin.
 
static void analog_write (u8 pin, u16 value)
 Write an analog value to a GPIO pin. More...
static void analog_write (u8 pin, u16 value)
 Write an analog value to a GPIO pin.
 
static u64 pulse_in (u8 pin, u8 state, u64 timeout)
 Measure the duration of a pulse on a GPIO pin. More...
static u64 pulse_in (u8 pin, u8 state, u64 timeout)
 Measure the duration of a pulse on a GPIO pin.
 
static u64 pulse_in_long (u8 pin, u8 state, u64 timeout)
 Measure the duration of a long pulse on a GPIO pin. More...
static u64 pulse_in_long (u8 pin, u8 state, u64 timeout)
 Measure the duration of a long pulse on a GPIO pin.
 
static u8 shift_in (u8 data, u8 clock, u8 bit_order)
 Shift in data from a digital input pin. More...
static u8 shift_in (u8 data, u8 clock, u8 bit_order)
 Shift in data from a digital input pin.
 
static void shift_out (u8 data, u8 clock, u8 bit_order, u8 value)
 Shift out data to a digital output pin. More...
static void shift_out (u8 data, u8 clock, u8 bit_order, u8 value)
 Shift out data to a digital output pin.
 
static void tone (u32 frequency, u64 duration)
 Generate a tone of the specified frequency and duration on GPIO25. More...
static void tone (u32 frequency, u64 duration)
 Generate a tone of the specified frequency and duration on GPIO25.
 
static void no_tone ()
 Stop generating a tone on GPIO25. More...
static void no_tone ()
 Stop generating a tone on GPIO25.
 

Detailed Description

-

Class for handling GPIO operations in Rishka applications.

-

The Gpio class provides static methods for configuring and manipulating General Purpose Input/Output (GPIO) pins on ESP32-WROVER microcontrollers. It includes functionalities for setting pin modes, reading digital and analog values, generating pulses, and controlling digital communication protocols.

+

Class for handling GPIO operations in Rishka applications.

+

The Gpio class provides static methods for configuring and manipulating General Purpose Input/Output (GPIO) pins on ESP32-WROVER microcontrollers. It includes functionalities for setting pin modes, reading digital and analog values, generating pulses, and controlling digital communication protocols.

Member Function Documentation

-

◆ analog_read()

+

◆ analog_read()

@@ -162,7 +169,7 @@

Read the analog value of a GPIO pin.

-

This method reads the analog value (0-1023) of the specified GPIO pin.

+

This method reads the analog value (0-1023) of the specified GPIO pin.

Parameters
@@ -174,7 +181,7 @@

-

◆ analog_write()

+

◆ analog_write()

@@ -208,7 +215,7 @@

Write an analog value to a GPIO pin.

-

This method writes the analog value (0-255) to the specified GPIO pin.

+

This method writes the analog value (0-255) to the specified GPIO pin.

Parameters

pinThe GPIO pin number.
@@ -220,7 +227,7 @@

-

◆ digital_read()

+

◆ digital_read()

@@ -244,7 +251,7 @@

Read the digital value of a GPIO pin.

-

This method reads the digital value (LOW or HIGH) of the specified GPIO pin.

+

This method reads the digital value (LOW or HIGH) of the specified GPIO pin.

Parameters

pinThe GPIO pin number.
@@ -256,7 +263,7 @@

-

◆ digital_write()

+

◆ digital_write()

@@ -290,7 +297,7 @@

Write a digital value to a GPIO pin.

-

This method writes the digital value (LOW or HIGH) to the specified GPIO pin.

+

This method writes the digital value (LOW or HIGH) to the specified GPIO pin.

Parameters

pinThe GPIO pin number.
@@ -302,7 +309,7 @@

-

◆ no_tone()

+

◆ no_tone()

@@ -325,12 +332,12 @@

Stop generating a tone on GPIO25.

-

This method stops generating a tone on GPIO25.

+

This method stops generating a tone on GPIO25.

-

◆ pin_mode()

+

◆ pin_mode()

@@ -364,7 +371,7 @@

Set the mode of a GPIO pin.

-

This method sets the mode of the specified GPIO pin to the given mode.

+

This method sets the mode of the specified GPIO pin to the given mode.

Parameters

pinThe GPIO pin number.
@@ -376,7 +383,7 @@

-

◆ pulse_in()

+

◆ pulse_in()

@@ -416,7 +423,7 @@

Measure the duration of a pulse on a GPIO pin.

-

This method measures the duration of a pulse of the specified state (HIGH or LOW) on the specified GPIO pin, with the specified timeout in microseconds.

+

This method measures the duration of a pulse of the specified state (HIGH or LOW) on the specified GPIO pin, with the specified timeout in microseconds.

Parameters

pinThe GPIO pin number.
@@ -430,7 +437,7 @@

-

◆ pulse_in_long()

+

◆ pulse_in_long()

@@ -470,7 +477,7 @@

Measure the duration of a long pulse on a GPIO pin.

-

This method measures the duration of a long pulse of the specified state (HIGH or LOW) on the specified GPIO pin, with the specified timeout in microseconds.

+

This method measures the duration of a long pulse of the specified state (HIGH or LOW) on the specified GPIO pin, with the specified timeout in microseconds.

Parameters

pinThe GPIO pin number.
@@ -484,7 +491,7 @@

-

◆ shift_in()

+

◆ shift_in()

@@ -524,7 +531,7 @@

Shift in data from a digital input pin.

-

This method shifts in data from a digital input pin using the specified clock pin and bit order (LSBFIRST or MSBFIRST).

+

This method shifts in data from a digital input pin using the specified clock pin and bit order (LSBFIRST or MSBFIRST).

Parameters

pinThe GPIO pin number.
@@ -538,7 +545,7 @@

-

◆ shift_out()

+

◆ shift_out()

@@ -584,7 +591,7 @@

Shift out data to a digital output pin.

-

This method shifts out data to a digital output pin using the specified clock pin, bit order (LSBFIRST or MSBFIRST), and data value.

+

This method shifts out data to a digital output pin using the specified clock pin, bit order (LSBFIRST or MSBFIRST), and data value.

Parameters

dataThe digital input pin number.
@@ -598,7 +605,7 @@

-

◆ tone()

+

◆ tone()

@@ -632,7 +639,7 @@

Generate a tone of the specified frequency and duration on GPIO25.

-

This method generates a tone of the specified frequency and duration on the GPIO25 using pulse-width modulation (PWM).

+

This method generates a tone of the specified frequency and duration on the GPIO25 using pulse-width modulation (PWM).

Parameters

dataThe digital output pin number.
@@ -645,7 +652,7 @@

gpio.h -
  • sdk/librishka_gpio.cpp
    • +
  • sdk/librishka_gpio.cpp
    • diff --git a/docs/d4/d9a/classFS-members.html b/docs/d4/d9a/classFS-members.html index ea76f89..f7f1212 100644 --- a/docs/d4/d9a/classFS-members.html +++ b/docs/d4/d9a/classFS-members.html @@ -1,9 +1,9 @@ - + - + Rishka: Member List @@ -36,10 +36,10 @@

    frequencyThe frequency of the tone in Hertz (Hz).

    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    diff --git a/docs/d4/dbc/group__Rishka__SDK.html b/docs/d4/dbc/group__Rishka__SDK.html index 45177c3..cb84eb3 100644 --- a/docs/d4/dbc/group__Rishka__SDK.html +++ b/docs/d4/dbc/group__Rishka__SDK.html @@ -1,9 +1,9 @@ - + - + Rishka: Rishka SDK @@ -36,10 +36,10 @@
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -96,13 +103,13 @@ - +

    Modules

     Rishka Drivers SDK
     Rishka Drivers SDK
     Group of headers for Rishka SDK drivers.
     

    Detailed Description

    -

    Rishka SDK provides a collection of headers for accessing various functionalities on ESP32-WROVER microcontrollers.

    -

    The Rishka SDK includes headers for GPIO, filesystem, I2C, SPI, interrupts, system calls, and other essential components for developing applications on the Rishka platform.

    +

    Rishka SDK provides a collection of headers for accessing various functionalities on ESP32-WROVER microcontrollers.

    +

    The Rishka SDK includes headers for GPIO, filesystem, I2C, SPI, interrupts, system calls, and other essential components for developing applications on the Rishka platform.

    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    diff --git a/docs/d5/daf/i2c_8h.html b/docs/d5/daf/i2c_8h.html index dc5a656..b9bf391 100644 --- a/docs/d5/daf/i2c_8h.html +++ b/docs/d5/daf/i2c_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/i2c.h File Reference @@ -36,10 +36,10 @@
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -104,8 +111,8 @@  

    Detailed Description

    -

    Header file for I2C (Inter-Integrated Circuit) operations in Rishka applications.

    -
    Author
    Nathanne Isip
    +

    Header file for I2C (Inter-Integrated Circuit) operations in Rishka applications.

    +
    Author
    Nathanne Isip

    This header file defines the I2C class, which provides functionalities for communicating with I2C devices on ESP32-WROVER microcontrollers.

    diff --git a/docs/d5/daf/i2c_8h_source.html b/docs/d5/daf/i2c_8h_source.html index 20f3dea..282a422 100644 --- a/docs/d5/daf/i2c_8h_source.html +++ b/docs/d5/daf/i2c_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/i2c.h Source File @@ -36,10 +36,10 @@
    - + @@ -53,6 +53,11 @@ /* @license-end */ +
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    diff --git a/docs/d6/d7c/gpio_8h.html b/docs/d6/d7c/gpio_8h.html index 323b68b..0166fed 100644 --- a/docs/d6/d7c/gpio_8h.html +++ b/docs/d6/d7c/gpio_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/gpio.h File Reference @@ -36,10 +36,10 @@
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -106,25 +113,25 @@ - -

    Enumerations

    enum  gpio_pin_mode_t { GPIO_INPUT = 0x01 +
    enum  gpio_pin_mode_t { GPIO_INPUT = 0x01 , GPIO_OUTPUT = 0x03 , GPIO_INPUT_PULLUP = 0x05 }
     Enum representing the pin modes for GPIO pins. More...
     
    enum  gpio_mode_t { GPIO_LOW = 0x0 +
    enum  gpio_mode_t { GPIO_LOW = 0x0 , GPIO_HIGH = 0x1 }
     Enum representing the digital modes for GPIO pins. More...
     

    Detailed Description

    -

    Header file for GPIO operations in Rishka applications.

    -
    Author
    Nathanne Isip
    +

    Header file for GPIO operations in Rishka applications.

    +
    Author
    Nathanne Isip

    This header file defines the Gpio class, which provides functionalities for interacting with General Purpose Input/Output (GPIO) pins on ESP32-WROVER microcontrollers.

    Enumeration Type Documentation

    -

    ◆ gpio_mode_t

    +

    ◆ gpio_mode_t

    @@ -136,21 +143,21 @@

    Enum representing the digital modes for GPIO pins.

    -

    This enum specifies the digital modes for GPIO pins.

      +

      This enum specifies the digital modes for GPIO pins.

      • GPIO_LOW: Represents a low digital value (0).
      • GPIO_HIGH: Represents a high digital value (1).
      - -
      Enumerator
      GPIO_LOW 

      Low digital value

      +
      Enumerator
      GPIO_LOW 

      Low digital value

      GPIO_HIGH 

      High digital value

      +
      GPIO_HIGH 

      High digital value

    -

    ◆ gpio_pin_mode_t

    +

    ◆ gpio_pin_mode_t

    @@ -162,17 +169,17 @@

    Enum representing the pin modes for GPIO pins.

    -

    This enum specifies the available pin modes for configuring GPIO pins.

      +

      This enum specifies the available pin modes for configuring GPIO pins.

      • GPIO_INPUT: Configures the pin as an input.
      • GPIO_OUTPUT: Configures the pin as an output.
      • GPIO_INPUT_PULLUP: Configures the pin as an input with a pull-up resistor enabled.
      - - -
      Enumerator
      GPIO_INPUT 

      Input mode

      +
      Enumerator
      GPIO_INPUT 

      Input mode

      GPIO_OUTPUT 

      Output mode

      +
      GPIO_OUTPUT 

      Output mode

      GPIO_INPUT_PULLUP 

      Input mode with pull-up resistor

      +
      GPIO_INPUT_PULLUP 

      Input mode with pull-up resistor

      diff --git a/docs/d6/d7c/gpio_8h_source.html b/docs/d6/d7c/gpio_8h_source.html index 9179b78..5a2e98b 100644 --- a/docs/d6/d7c/gpio_8h_source.html +++ b/docs/d6/d7c/gpio_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/gpio.h Source File @@ -36,10 +36,10 @@

    - + @@ -53,6 +53,11 @@ /* @license-end */ +
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -99,70 +106,70 @@ - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

    Static Public Member Functions

    static bool begin (u8 address)
     Initialize the I2C communication with the specified address. More...
    static bool begin (u8 address)
     Initialize the I2C communication with the specified address.
     
    static bool end ()
     End the I2C communication. More...
    static bool end ()
     End the I2C communication.
     
    static bool pins (u8 sda, u8 scl)
     Set the SDA and SCL pins for the I2C communication. More...
    static bool pins (u8 sda, u8 scl)
     Set the SDA and SCL pins for the I2C communication.
     
    static void flush ()
     Flush the I2C buffer. More...
    static void flush ()
     Flush the I2C buffer.
     
    static void begin_transmission (u8 address)
     Begin an I2C transmission to the specified device address. More...
    static void begin_transmission (u8 address)
     Begin an I2C transmission to the specified device address.
     
    static u8 end_transmission (bool stop_bit)
     End an I2C transmission with an optional stop bit. More...
    static u8 end_transmission (bool stop_bit)
     End an I2C transmission with an optional stop bit.
     
    static usize write (u8 *data, usize size)
     Write data to the I2C bus. More...
    static usize write (u8 *data, usize size)
     Write data to the I2C bus.
     
    static usize slave_write (u8 *data, usize size)
     Write data to the I2C bus as a slave device. More...
    static usize slave_write (u8 *data, usize size)
     Write data to the I2C bus as a slave device.
     
    static usize set_buffersize (usize size)
     Set the buffer size for I2C transactions. More...
    static usize set_buffersize (usize size)
     Set the buffer size for I2C transactions.
     
    static i32 read ()
     Read data from the I2C bus. More...
    static i32 read ()
     Read data from the I2C bus.
     
    static i32 peek ()
     Peek at the next byte on the I2C bus. More...
    static i32 peek ()
     Peek at the next byte on the I2C bus.
     
    static i32 available ()
     Get the number of bytes available for reading on the I2C bus. More...
    static i32 available ()
     Get the number of bytes available for reading on the I2C bus.
     
    static usize request (u8 address, usize size, bool stop_bit)
     Request data from a remote I2C device. More...
    static usize request (u8 address, usize size, bool stop_bit)
     Request data from a remote I2C device.
     
    static void on_receive (void(*callback)(int))
     Register a callback function for I2C receive events. More...
    static void on_receive (void(*callback)(int))
     Register a callback function for I2C receive events.
     
    static void on_request (void(*callback)(void))
     Register a callback function for I2C request events. More...
    static void on_request (void(*callback)(void))
     Register a callback function for I2C request events.
     
    static void set_timeout (u16 timeout)
     Set the timeout for I2C operations. More...
    static void set_timeout (u16 timeout)
     Set the timeout for I2C operations.
     
    static u16 get_timeout ()
     Get the current timeout for I2C operations. More...
    static u16 get_timeout ()
     Get the current timeout for I2C operations.
     
    static bool set_clock (u32 clock)
     Set the clock frequency for I2C communication. More...
    static bool set_clock (u32 clock)
     Set the clock frequency for I2C communication.
     
    static u32 get_clock ()
     Get the current clock frequency for I2C communication. More...
    static u32 get_clock ()
     Get the current clock frequency for I2C communication.
     

    Detailed Description

    -

    Class for handling I2C operations in Rishka applications.

    -

    The I2C class provides static methods for initializing, configuring, and communicating with I2C devices on ESP32-WROVER microcontrollers. It includes functionalities for setting up the I2C bus, beginning and ending I2C transactions, reading and writing data, registering callbacks for I2C events, and setting the clock frequency and timeout.

    +

    Class for handling I2C operations in Rishka applications.

    +

    The I2C class provides static methods for initializing, configuring, and communicating with I2C devices on ESP32-WROVER microcontrollers. It includes functionalities for setting up the I2C bus, beginning and ending I2C transactions, reading and writing data, registering callbacks for I2C events, and setting the clock frequency and timeout.

    Member Function Documentation

    -

    ◆ available()

    +

    ◆ available()

    @@ -185,13 +192,13 @@

    Get the number of bytes available for reading on the I2C bus.

    -

    This method returns the number of bytes available for reading on the I2C bus. It can be used to determine the amount of data available for reading.

    +

    This method returns the number of bytes available for reading on the I2C bus. It can be used to determine the amount of data available for reading.

    Returns
    The number of bytes available for reading.

    -

    ◆ begin()

    +

    ◆ begin()

    @@ -215,7 +222,7 @@

    Initialize the I2C communication with the specified address.

    -

    This method initializes the I2C communication with the specified 7-bit address. It should be called before any other I2C communication functions are used.

    +

    This method initializes the I2C communication with the specified 7-bit address. It should be called before any other I2C communication functions are used.

    Parameters
    @@ -227,7 +234,7 @@

    -

    ◆ begin_transmission()

    +

    ◆ begin_transmission()

    @@ -251,7 +258,7 @@

    Begin an I2C transmission to the specified device address.

    -

    This method begins an I2C transmission to the specified device address. Subsequent write operations will send data to the specified device.

    +

    This method begins an I2C transmission to the specified device address. Subsequent write operations will send data to the specified device.

    Parameters

    addressThe 7-bit address of the I2C device.
    @@ -262,7 +269,7 @@

    -

    ◆ end()

    +

    ◆ end()

    @@ -285,13 +292,13 @@

    End the I2C communication.

    -

    This method ends the I2C communication and releases the associated resources. It should be called to clean up the I2C interface after use.

    +

    This method ends the I2C communication and releases the associated resources. It should be called to clean up the I2C interface after use.

    Returns
    True if ending the communication was successful, false otherwise.

    -

    ◆ end_transmission()

    +

    ◆ end_transmission()

    @@ -315,7 +322,7 @@

    End an I2C transmission with an optional stop bit.

    -

    This method ends an I2C transmission with an optional stop bit. If the stop_bit parameter is true, a stop condition will be generated on the bus after the transmission is complete.

    +

    This method ends an I2C transmission with an optional stop bit. If the stop_bit parameter is true, a stop condition will be generated on the bus after the transmission is complete.

    Parameters

    addressThe 7-bit address of the I2C device.
    @@ -327,7 +334,7 @@

    -

    ◆ flush()

    +

    ◆ flush()

    @@ -350,12 +357,12 @@

    Flush the I2C buffer.

    -

    This method flushes the I2C buffer, discarding any unread data. It can be called to clear the buffer before initiating a new transaction.

    +

    This method flushes the I2C buffer, discarding any unread data. It can be called to clear the buffer before initiating a new transaction.

    -

    ◆ get_clock()

    +

    ◆ get_clock()

    @@ -378,13 +385,13 @@

    Get the current clock frequency for I2C communication.

    -

    This method returns the current clock frequency for I2C communication in Hertz (Hz).

    +

    This method returns the current clock frequency for I2C communication in Hertz (Hz).

    Returns
    The current clock frequency in Hertz (Hz).

    -

    ◆ get_timeout()

    +

    ◆ get_timeout()

    @@ -407,13 +414,13 @@

    Get the current timeout for I2C operations.

    -

    This method returns the current timeout for I2C operations in microseconds.

    +

    This method returns the current timeout for I2C operations in microseconds.

    Returns
    The current timeout value in microseconds.

    -

    ◆ on_receive()

    +

    ◆ on_receive()

    @@ -437,7 +444,7 @@

    Register a callback function for I2C receive events.

    -

    This method registers a callback function to be called when data is received on the I2C bus as a slave device. The callback function should take an integer parameter representing the number of bytes received.

    +

    This method registers a callback function to be called when data is received on the I2C bus as a slave device. The callback function should take an integer parameter representing the number of bytes received.

    Parameters

    stop_bitTrue to generate a stop condition, false otherwise.
    @@ -448,7 +455,7 @@

    -

    ◆ on_request()

    +

    ◆ on_request()

    @@ -472,7 +479,7 @@

    Register a callback function for I2C request events.

    -

    This method registers a callback function to be called when a master device requests data from the I2C slave device. The callback function should not take any parameters.

    +

    This method registers a callback function to be called when a master device requests data from the I2C slave device. The callback function should not take any parameters.

    Parameters

    callbackPointer to the callback function.
    @@ -483,7 +490,7 @@

    -

    ◆ peek()

    +

    ◆ peek()

    @@ -506,13 +513,13 @@

    Peek at the next byte on the I2C bus.

    -

    This method peeks at the next byte on the I2C bus without removing it from the buffer. It is useful for checking if data is available for reading.

    +

    This method peeks at the next byte on the I2C bus without removing it from the buffer. It is useful for checking if data is available for reading.

    Returns
    The next byte on the I2C bus, or -1 if no data is available.

    -

    ◆ pins()

    +

    ◆ pins()

    @@ -546,7 +553,7 @@

    Set the SDA and SCL pins for the I2C communication.

    -

    This method sets the SDA (data) and SCL (clock) pins for the I2C communication. It should be called to configure the GPIO pins used for I2C communication.

    +

    This method sets the SDA (data) and SCL (clock) pins for the I2C communication. It should be called to configure the GPIO pins used for I2C communication.

    Parameters

    callbackPointer to the callback function.
    @@ -559,7 +566,7 @@

    -

    ◆ read()

    +

    ◆ read()

    @@ -582,13 +589,13 @@

    Read data from the I2C bus.

    -

    This method reads data from the I2C bus received from the device specified in the begin_transmission() method.

    +

    This method reads data from the I2C bus received from the device specified in the begin_transmission() method.

    Returns
    The received data byte.

    -

    ◆ request()

    +

    ◆ request()

    @@ -628,7 +635,7 @@

    Request data from a remote I2C device.

    -

    This method requests data from a remote I2C device with the specified address and size, optionally generating a stop condition after the request.

    +

    This method requests data from a remote I2C device with the specified address and size, optionally generating a stop condition after the request.

    Parameters

    sdaThe pin number for the SDA (data) line.
    @@ -642,7 +649,7 @@

    -

    ◆ set_buffersize()

    +

    ◆ set_buffersize()

    @@ -666,7 +673,7 @@

    Set the buffer size for I2C transactions.

    -

    This method sets the buffer size for I2C transactions. It should be called before beginning an I2C transmission.

    +

    This method sets the buffer size for I2C transactions. It should be called before beginning an I2C transmission.

    Parameters

    addressThe 7-bit address of the remote I2C device.
    @@ -678,7 +685,7 @@

    -

    ◆ set_clock()

    +

    ◆ set_clock()

    @@ -702,7 +709,7 @@

    Set the clock frequency for I2C communication.

    -

    This method sets the clock frequency for I2C communication in Hertz (Hz).

    +

    This method sets the clock frequency for I2C communication in Hertz (Hz).

    Parameters

    sizeThe buffer size in bytes.
    @@ -714,7 +721,7 @@

    -

    ◆ set_timeout()

    +

    ◆ set_timeout()

    @@ -738,7 +745,7 @@

    Set the timeout for I2C operations.

    -

    This method sets the timeout for I2C operations in microseconds. It specifies the maximum time allowed for an I2C operation to complete.

    +

    This method sets the timeout for I2C operations in microseconds. It specifies the maximum time allowed for an I2C operation to complete.

    Parameters

    clockThe clock frequency in Hertz (Hz).
    @@ -749,7 +756,7 @@

    -

    ◆ slave_write()

    +

    ◆ slave_write()

    @@ -783,7 +790,7 @@

    Write data to the I2C bus as a slave device.

    -

    This method writes data to the I2C bus as a slave device. It is typically used in response to a master device's request.

    +

    This method writes data to the I2C bus as a slave device. It is typically used in response to a master device's request.

    Parameters

    timeoutThe timeout value in microseconds.
    @@ -796,7 +803,7 @@

    -

    ◆ write()

    +

    ◆ write()

    @@ -830,7 +837,7 @@

    Write data to the I2C bus.

    -

    This method writes data to the I2C bus for transmission to the device specified in the begin_transmission() method.

    +

    This method writes data to the I2C bus for transmission to the device specified in the begin_transmission() method.

    Parameters

    dataPointer to the data buffer.
    @@ -844,7 +851,7 @@

    i2c.h -
  • sdk/librishka_i2c.cpp
    • +
  • sdk/librishka_i2c.cpp
    • diff --git a/docs/d6/da0/keyboard_8h.html b/docs/d6/da0/keyboard_8h.html index fa1ab4d..17848ef 100644 --- a/docs/d6/da0/keyboard_8h.html +++ b/docs/d6/da0/keyboard_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/drivers/keyboard.h File Reference @@ -36,10 +36,10 @@

    dataPointer to the data buffer.

    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -105,8 +112,8 @@  

    Detailed Description

    -

    This header file defines the Keyboard class, providing access to keyboard-related functionalities in the Rishka VM SDK.

    -
    Author
    Nathanne Isip
    +

    This header file defines the Keyboard class, providing access to keyboard-related functionalities in the Rishka VM SDK.

    +
    Author
    Nathanne Isip

    The Keyboard class allows interaction with various keyboard-related functionalities in the Rishka VM SDK. It includes methods for retrieving information about the keyboard layout, checking the status of lock keys (Num Lock, Caps Lock, Scroll Lock), controlling the state of these lock keys, obtaining keyboard scan codes, and performing operations such as locking, unlocking, and resetting the keyboard.

    diff --git a/docs/d6/da0/keyboard_8h_source.html b/docs/d6/da0/keyboard_8h_source.html index 139e663..30f0622 100644 --- a/docs/d6/da0/keyboard_8h_source.html +++ b/docs/d6/da0/keyboard_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka/drivers/keyboard.h Source File @@ -36,10 +36,10 @@
    - + @@ -53,6 +53,11 @@ /* @license-end */ +
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -99,28 +106,28 @@ - - + + - - + + - - + + - - + + - - + +

    Static Public Member Functions

    static i32 screen_height ()
     Get the height of the screen. More...
    static i32 screen_height ()
     Get the height of the screen.
     
    static i32 screen_width ()
     Get the width of the screen. More...
    static i32 screen_width ()
     Get the width of the screen.
     
    static i32 viewport_height ()
     Get the height of the viewport. More...
    static i32 viewport_height ()
     Get the height of the viewport.
     
    static i32 viewport_width ()
     Get the width of the viewport. More...
    static i32 viewport_width ()
     Get the width of the viewport.
     
    static i32 supported_colors ()
     Get the number of supported colors. More...
    static i32 supported_colors ()
     Get the number of supported colors.
     

    Detailed Description

    -

    Final class to interact with display hardware.

    -

    The Display class contains only static methods and cannot be instantiated. It provides methods to get the screen and viewport dimensions as well as the number of supported colors. This class serves as a utility for querying display properties, allowing developers to adapt their applications based on the display characteristics.

    +

    Final class to interact with display hardware.

    +

    The Display class contains only static methods and cannot be instantiated. It provides methods to get the screen and viewport dimensions as well as the number of supported colors. This class serves as a utility for querying display properties, allowing developers to adapt their applications based on the display characteristics.

    Member Function Documentation

    -

    ◆ screen_height()

    +

    ◆ screen_height()

    @@ -149,7 +156,7 @@

    -

    ◆ screen_width()

    +

    ◆ screen_width()

    @@ -178,7 +185,7 @@

    -

    ◆ supported_colors()

    +

    ◆ supported_colors()

    @@ -207,7 +214,7 @@

    -

    ◆ viewport_height()

    +

    ◆ viewport_height()

    @@ -236,7 +243,7 @@

    -

    ◆ viewport_width()

    +

    ◆ viewport_width()

    @@ -266,7 +273,7 @@

    display.h -
  • sdk/librishka_drivers_display.cpp
    • +
  • sdk/librishka_drivers_display.cpp

    • diff --git a/docs/d6/dd8/classRuntime.html b/docs/d6/dd8/classRuntime.html index 9bc1cc4..f710282 100644 --- a/docs/d6/dd8/classRuntime.html +++ b/docs/d6/dd8/classRuntime.html @@ -1,9 +1,9 @@ - + - + Rishka: Runtime Class Reference @@ -36,10 +36,10 @@

    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -99,19 +106,19 @@ - - + + - - + +

    Static Public Member Functions

    static void yield ()
     Yield the execution context to other tasks or threads. More...
    static void yield ()
     Yield the execution context to other tasks or threads.
     
    static string get_fork_stream ()
     Retrieves the fork stream. More...
    static string get_fork_stream ()
     Retrieves the fork stream.
     

    Detailed Description

    -

    The Runtime class provides utilities for managing runtime operations.

    -

    The Runtime class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management.

    +

    The Runtime class provides utilities for managing runtime operations.

    +

    The Runtime class encapsulates functionality related to runtime management and control flow within Rishka applications. It serves as a central hub for coordinating runtime activities, such as task scheduling, event processing, and resource management.

    Member Function Documentation

    -

    ◆ get_fork_stream()

    +

    ◆ get_fork_stream()

    @@ -134,13 +141,13 @@

    Retrieves the fork stream.

    -

    This static method returns the current stream text content from the fork program previously executed. The stream contains all of the printed text of the previously executed program.

    +

    This static method returns the current stream text content from the fork program previously executed. The stream contains all of the printed text of the previously executed program.

    Returns
    A string containing the content of the fork stream.

    -

    ◆ yield()

    +

    ◆ yield()

    @@ -163,13 +170,13 @@

    Yield the execution context to other tasks or threads.

    -

    The yield() function allows cooperative multitasking by yielding the execution context to other tasks or threads within the application. By invoking this function, the currently executing task relinquishes control of the CPU, allowing other tasks or threads to execute. This method is useful for implementing cooperative multitasking or event-driven programming paradigms, where tasks voluntarily yield control to other tasks or respond to external events.

    +

    The yield() function allows cooperative multitasking by yielding the execution context to other tasks or threads within the application. By invoking this function, the currently executing task relinquishes control of the CPU, allowing other tasks or threads to execute. This method is useful for implementing cooperative multitasking or event-driven programming paradigms, where tasks voluntarily yield control to other tasks or respond to external events.

    The documentation for this class was generated from the following files:
    • sdk/librishka/runtime.h
      • -
    • sdk/librishka_rt.cpp
      • +
    • sdk/librishka_rt.cpp
    diff --git a/docs/d6/de4/librishka_8h.html b/docs/d6/de4/librishka_8h.html index d066d2e..bebe7b8 100644 --- a/docs/d6/de4/librishka_8h.html +++ b/docs/d6/de4/librishka_8h.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka.h File Reference @@ -36,10 +36,10 @@
    - + @@ -79,9 +79,16 @@
    - +
    +
    +
    +
    +
    Loading...
    +
    Searching...
    +
    No Matches
    +
    +
    +
    @@ -109,8 +116,8 @@

    Go to the source code of this file.

    Detailed Description

    -

    Main header file for the Rishka SDK.

    -
    Author
    Nathanne Isip
    +

    Main header file for the Rishka SDK.

    +
    Author
    Nathanne Isip

    This header file includes all the necessary headers from the Rishka SDK for easy integration and usage of Rishka functionalities in your projects.

    diff --git a/docs/d6/de4/librishka_8h_source.html b/docs/d6/de4/librishka_8h_source.html index 1145644..226e972 100644 --- a/docs/d6/de4/librishka_8h_source.html +++ b/docs/d6/de4/librishka_8h_source.html @@ -1,9 +1,9 @@ - + - + Rishka: sdk/librishka.h Source File @@ -36,10 +36,10 @@
    - + @@ -53,6 +53,11 @@ /* @license-end */ +