-
-
- Generated by
1.11.0
-
|
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
API entrypoint for robodash. -More...
- -Go to the source code of this file.
--Macros | |
| -#define | ROBODASH |
| -#define | RD_VERSION_MAJOR 2 |
| -#define | RD_VERSION_MINOR 2 |
| -#define | RD_VERSION_PATCH 0 |
API entrypoint for robodash.
-Includes all necessary functions to use robodash.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
#include "api.h"#include "impl/assets.h"#include "impl/filesystem.h"#include "impl/styles.h" 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Images and fonts used by robodash. -More...
-#include "robodash/apix.h"Go to the source code of this file.
--Variables | |
| -lv_font_t | source_code_pro_16 |
| -lv_img_t | stack |
Images and fonts used by robodash.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
This is the complete list of members for rd::Console, including all inherited members.
-| clear() | rd::Console | |
| Console(std::string name="Console") | rd::Console | |
| focus() | rd::Console | |
| print(std::string str) | rd::Console | |
| printf(std::string fmt, Params... args) | rd::Console | inline |
| println(std::string str) | rd::Console |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
#include <console.hpp>
Console Functions | |
| Console (std::string name="Console") | |
| Create a new Console. | |
| -void | clear () |
| Clear all console lines. | |
| void | print (std::string str) |
| Print to the console. | |
| void | println (std::string str) |
| Print to the console with a newline. | |
| template<typename... Params> | |
| void | printf (std::string fmt, Params... args) |
| Print a formatted string to the console. | |
| -void | focus () |
| Set this view to the active view. | |
Console class.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
#include <image.hpp>
Image Functions | |
| Image (std::string path, std::string name="Image") | |
| Create a new Image. | |
| Image (lv_img_dsc_t image_dsc, std::string name="Image") | |
| Create a new Image. | |
| -void | focus () |
| Set this view to the active view. | |
Image class.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
This is the complete list of members for rd::Selector, including all inherited members.
-| focus() | rd::Selector | |
| routine_action_t typedef (defined in rd::Selector) | rd::Selector | |
| routine_t typedef (defined in rd::Selector) | rd::Selector | |
| run_auton() | rd::Selector | |
| Selector(std::string name, std::vector< routine_t > autons) | rd::Selector | |
| Selector(std::vector< routine_t > autons) | rd::Selector |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
#include <selector.hpp>
-Classes | |
| struct | routine |
-Public Types | |
Selector Typedefs | |
| -typedef std::function< void()> | routine_action_t |
| -typedef struct rd::Selector::routine | routine_t |
-Public Member Functions | |
Selector Functions | |
| Selector (std::string name, std::vector< routine_t > autons) | |
| Create autonomous selector. | |
| Selector (std::vector< routine_t > autons) | |
| Create autonomous selector. | |
| -void | run_auton () |
| Run selected auton. | |
| -void | focus () |
| Set this view to the active view. | |
Selector class.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Robodash Console. -More...
- -Go to the source code of this file.
--Classes | |
| class | rd::Console |
| Console class. More... | |
Robodash Console.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Robodash core header. -More...
-#include "liblvgl/lvgl.h"Go to the source code of this file.
--Classes | |
| struct | rd_view |
| Robodash view structure. More... | |
-Typedefs | |
| -typedef enum rd_anim_state | rd_anim_state_t |
| Animation state. | |
| -typedef struct rd_view | rd_view_t |
| Robodash view structure. | |
-Enumerations | |
| enum | rd_anim_state { RD_ANIM_ON -, RD_ANIM_OFF - } |
| Animation state. | |
-Functions | |
| rd_view_t * | rd_view_create (const char *name) |
| Create a view. | |
| void | rd_view_focus (rd_view_t *view) |
| Set a view to the currently active view. | |
| void | rd_view_del (rd_view_t *view) |
| Delete a view. | |
| lv_obj_t * | rd_view_obj (rd_view_t *view) |
| Get the view's lvgl object. | |
| void | rd_view_alert (rd_view_t *view, const char *msg) |
| Push an alert. | |
| void | rd_view_set_anims (rd_view_t *view, rd_anim_state_t state) |
| Enable or disable animations for a view. | |
| rd_anim_state_t | rd_view_get_anims (rd_view_t *view) |
| Get the animation state for a view. | |
Robodash core header.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
-Files | |
| console.hpp | |
| Robodash Console. | |
| image.hpp | |
| Robodash Image. | |
| selector.hpp | |
| Robodash Selector. | |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
-Files | |
| assets.h | |
| Images and fonts used by robodash. | |
| filesystem.h | |
| LVGL filesystem driver for images. | |
| styles.h | |
| Styles used by robodash. | |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
| ▼ impl | |
| assets.h | Images and fonts used by robodash |
| filesystem.h | LVGL filesystem driver for images |
| styles.h | Styles used by robodash |
| ▼ views | |
| console.hpp | Robodash Console |
| image.hpp | Robodash Image |
| selector.hpp | Robodash Selector |
| api.h | API entrypoint for robodash |
| apix.h | |
| core.h | Robodash core header |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
LVGL filesystem driver for images. -More...
- -Go to the source code of this file.
--Functions | |
| -void | _init_fs () |
LVGL filesystem driver for images.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
A console for debugging. -More...
--Files | |
| file | console.hpp |
| Robodash Console. | |
-Classes | |
| class | rd::Console |
| Console class. More... | |
Console Functions | |
| rd::Console::Console (std::string name="Console") | |
| Create a new Console. | |
| -void | rd::Console::clear () |
| Clear all console lines. | |
| void | rd::Console::print (std::string str) |
| Print to the console. | |
| void | rd::Console::println (std::string str) |
| Print to the console with a newline. | |
| template<typename... Params> | |
| void | rd::Console::printf (std::string fmt, Params... args) |
| Print a formatted string to the console. | |
| -void | rd::Console::focus () |
| Set this view to the active view. | |
A console for debugging.
-
-A GUI console for debugging. Emulates a standard console output.
-| rd::Console::Console | -( | -std::string | name = "Console" | ) | -- |
Create a new Console.
-| name | Name to display on screen |
| void rd::Console::print | -( | -std::string | str | ) | -- |
Print to the console.
-| str | String to print to console |
-
|
- -inline | -
Print a formatted string to the console.
-| Params |
| fmt | Format string |
| args | Args for format string |
| void rd::Console::println | -( | -std::string | str | ) | -- |
Print to the console with a newline.
-| str | String to print to console |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
The view management system. -More...
--Files | |
| file | core.h |
| Robodash core header. | |
-Classes | |
| struct | rd_view |
| Robodash view structure. More... | |
-Typedefs | |
| -typedef enum rd_anim_state | rd_anim_state_t |
| Animation state. | |
| -typedef struct rd_view | rd_view_t |
| Robodash view structure. | |
-Enumerations | |
| enum | rd_anim_state { RD_ANIM_ON -, RD_ANIM_OFF - } |
| Animation state. | |
-Functions | |
| rd_view_t * | rd_view_create (const char *name) |
| Create a view. | |
| void | rd_view_focus (rd_view_t *view) |
| Set a view to the currently active view. | |
| void | rd_view_del (rd_view_t *view) |
| Delete a view. | |
| lv_obj_t * | rd_view_obj (rd_view_t *view) |
| Get the view's lvgl object. | |
| void | rd_view_alert (rd_view_t *view, const char *msg) |
| Push an alert. | |
| void | rd_view_set_anims (rd_view_t *view, rd_anim_state_t state) |
| Enable or disable animations for a view. | |
| rd_anim_state_t | rd_view_get_anims (rd_view_t *view) |
| Get the animation state for a view. | |
The view management system.
-The LVGL view management system to enable compatibility between templates that provide LVGL GUIs. Knowledge of LVGL is required to use this API.
-| void rd_view_alert | -( | -rd_view_t * | view, | -
| - | - | const char * | msg ) | -
Push an alert.
-Pushes an alert to the screen, regardless of which view is active.
-| view | View to link back to |
| msg | Message to display |
| rd_view_t * rd_view_create | -( | -const char * | name | ) | -- |
Create a view.
-| name | Name of the view |
| void rd_view_del | -( | -rd_view_t * | view | ) | -- |
Delete a view.
-NULL.| view | View to delete |
| void rd_view_focus | -( | -rd_view_t * | view | ) | -- |
Set a view to the currently active view.
-| view | View to focus |
| rd_anim_state_t rd_view_get_anims | -( | -rd_view_t * | view | ) | -- |
Get the animation state for a view.
-| view | View to query |
| lv_obj_t * rd_view_obj | -( | -rd_view_t * | view | ) | -- |
Get the view's lvgl object.
-| view | View to query |
| void rd_view_set_anims | -( | -rd_view_t * | view, | -
| - | - | rd_anim_state_t | state ) | -
Enable or disable animations for a view.
-| view | View to modify |
| state | Animation state |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
An image display. -More...
--Files | |
| file | image.hpp |
| Robodash Image. | |
-Classes | |
| class | rd::Image |
| Image class. More... | |
Image Functions | |
| rd::Image::Image (std::string path, std::string name="Image") | |
| Create a new Image. | |
| rd::Image::Image (lv_img_dsc_t image_dsc, std::string name="Image") | |
| Create a new Image. | |
| -void | rd::Image::focus () |
| Set this view to the active view. | |
An image display.
-
-Displays still images from an SD card or C array.
-| rd::Image::Image | -( | -lv_img_dsc_t | image_dsc, | -
| - | - | std::string | name = "Image" ) | -
Create a new Image.
-| image_dsc | LVGL image descriptor object |
| name | Name to display on screen |
| rd::Image::Image | -( | -std::string | path, | -
| - | - | std::string | name = "Image" ) | -
Create a new Image.
-| path | File path to the binary-formatted image on SD card |
| name | Name to display on screen |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
A function selector. -More...
--Files | |
| file | selector.hpp |
| Robodash Selector. | |
-Classes | |
| class | rd::Selector |
| Selector class. More... | |
| struct | rd::Selector::routine |
-Variables | |
| -std::string | rd::Selector::routine::name |
| -routine_action_t | rd::Selector::routine::action |
| -std::string | rd::Selector::routine::img = "" |
Selector Typedefs | |
| -typedef std::function< void()> | rd::Selector::routine_action_t |
| -typedef struct rd::Selector::routine | rd::Selector::routine_t |
Selector Functions | |
| rd::Selector::Selector (std::string name, std::vector< routine_t > autons) | |
| Create autonomous selector. | |
| rd::Selector::Selector (std::vector< routine_t > autons) | |
| Create autonomous selector. | |
| -void | rd::Selector::run_auton () |
| Run selected auton. | |
| -void | rd::Selector::focus () |
| Set this view to the active view. | |
A function selector.
-
-A function selector for easily managing autonomous routines. If available, automatically saves the current configuration to an SD card and loads it on the next run. Also supports displaying images from the SD card.
-| rd::Selector::Selector | -( | -std::string | name, | -
| - | - | std::vector< routine_t > | autons ) | -
Create autonomous selector.
-| name | Name of the autonomous selector |
| autons | Vector of autonomous rotuines |
| rd::Selector::Selector | -( | -std::vector< routine_t > | autons | ) | -- |
Create autonomous selector.
-| autons | Vector of autonomous rotuines |
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Robodash Image. -More...
- -Go to the source code of this file.
--Classes | |
| class | rd::Image |
| Image class. More... | |
Robodash Image.
- 1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
1.11.0 |
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Robodash is a GUI toolkit for PROS 4 that provides a suite of easy to use GUI utilities and an API for interoperable LVGL-based user interfaces.
-To get started, visit the Installation page.
-Robodash was created to solve a problem with the V5 LCD – it is incredibly underutilized. There are two parts to this issue: ease of use and sharing.
-For one, most people opt to use the legacy LCD emulator since it is the easiest and fastest way to utilize the V5 screen. While an alright solution, the V5 LCD isnt completely taken advantage of in this scenario and additional code is required to display other information like a graph or images.
-Secondly, the V5 screen cannot be easily shared by multiple pieces of code. If a template wants to provide a GUI widget, this may interfere with a user's autonomous selector or another template's GUI with no way to switch between them.
-Robodash aims to solve these two issues by providing a set of easy to use GUI utilities for users, and an API for template developers to create LVGL GUIS that work in harmony with each other.
- 1.11.0 Documentation moved to readthedocs.
+You will be redirected automatically.
- diff --git a/installing.html b/installing.html deleted file mode 100644 index 9183d04..0000000 --- a/installing.html +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - - - -|
-
- Robodash 2.1.1
-
- A GUI toolkit for PROS 4
- |
-
Before you install robodash you must have the following:
-Before adding robodash to your project, you'll need to register the depot with the PROS CLI. A depot is a remote file that informs the PROS CLI of templates that exist and where they can be installed from. You can run the command below to add the depot.
-Alternatively, you can download and register an individual version of robodash by downloading it from the releases tab on the GitHub page and registering it with pros c fetch robodash@x.x.x.zip. This is not recommended since you will have to manually repeat this step as robodash updates.
Now let's add robodash to a project. Open the project you wish to use the robodash in and run the command below to apply it to your project.
-You can now add the following to your project's main.h file to use robodash.
1.11.0 
');
- }
-
- const showSyncOn = function(n,relpath) {
- n.html('
');
- }
-
- const o = {
- toroot : toroot,
- node : {
- childrenData : NAVTREE,
- children : [],
- childrenUL : document.createElement("ul"),
- getChildrenUL : function() { return this.childrenUL },
- li : document.getElementById("nav-tree-contents"),
- depth : 0,
- relpath : relpath,
- expanded : false,
- isLast : true,
- plus_img : document.createElement("span"),
- },
- };
- o.node.li.appendChild(o.node.childrenUL);
- o.node.plus_img.className = 'arrow';
- o.node.plus_img.innerHTML = ARROW_RIGHT;
-
- const navSync = $('#nav-sync');
- if (cachedLink()) {
- showSyncOff(navSync,relpath);
- navSync.removeClass('sync');
- } else {
- showSyncOn(navSync,relpath);
- }
-
- navSync.click(() => {
- const navSync = $('#nav-sync');
- if (navSync.hasClass('sync')) {
- navSync.removeClass('sync');
- showSyncOff(navSync,relpath);
- storeLink(stripPath2(pathName())+hashUrl());
- } else {
- navSync.addClass('sync');
- showSyncOn(navSync,relpath);
- deleteLink();
- }
- });
-
- navTo(o,toroot,hashUrl(),relpath);
- showRoot();
-
- $(window).bind('hashchange', () => {
- if (!animationInProgress) {
- if (window.location.hash && window.location.hash.length>1) {
- let a;
- if ($(location).attr('hash')) {
- const clslink=stripPath(pathName())+':'+hashValue();
- a=$('.item a[class$="'+clslink.replace(/
-
-
-
-
-
-
-
- 
-
-
-
-