+ The
get_value function returns the current value of a
+ specified
param on a device with the specified{' '}
+
device_id.
+
+ Parameters:
+
+ -
+
device_id: the ID that
+ specifies which PiE device will be read
+
+ -
+
param: identifies which
+ parameter on the specified PiE device will be read. Possible param
+ values depend on the specified device. Find a list of params for each
+ type of device on the{' '}
+ lowcar devices page.
+
+
+ The function is useful for checking the current state of devices. For
+ example, getting the current state of a limit switch using its{' '}
+
device_id and the
param "switch0" will
+ return True when pressed down and False if not.
+
{`
+ # First segment of code ran in the teleop process
+ limit_switch = "//INSERT SWITCH ID HERE//"
+
+ def teleop_setup():
+ print("Tele-operated mode has started!")
+
+ def teleop_main():
+ # Example code for getting the value of a limit switch
+ # First parameter is the limit switch's id
+ # Second parameter tells which switch to get the value from
+ # In this case the method will return True or False depending on if the switch is pressed down or not
+
+ Robot.get_value(limit_switch, switch0)
+ `}
+
Documentation for Robot object.
,
+};
+
+/**
+ * Configures hover tooltips for PiE API stuff in the given editor.
+ * @param editor - the editor to modify
+ */
+export default function addEditorTooltips(editor: Ace.Editor) {
+ const tooltip = new HoverTooltip();
+ const node = document.createElement('div');
+ const root = createRoot(node);
+ // Check just past longest match in case the very next character
+ const maxMatchTextLength =
+ Math.max(...Object.keys(apiHelpComponents).map((s) => s.length)) + 1;
+ tooltip.setDataProvider((event: any, _editor: Ace.Editor) => {
+ const pos: Ace.Position = event.getDocumentPosition();
+ const range = editor.session.getWordRange(pos.row, pos.column);
+ const result = readApiCall(editor.session, range.end, maxMatchTextLength);
+ if (result in apiHelpComponents) {
+ root.render(apiHelpComponents[result]());
+ tooltip.showForRange(editor, range, node, event);
+ }
+ });
+ tooltip.addToEditor(editor);
+}
diff --git a/src/renderer/editor/readApiCall.ts b/src/renderer/editor/readApiCall.ts
new file mode 100644
index 0000000..4f01611
--- /dev/null
+++ b/src/renderer/editor/readApiCall.ts
@@ -0,0 +1,71 @@
+import { Ace, require as acequire } from 'ace-builds';
+
+const { TokenIterator } = acequire('ace/token_iterator');
+
+/**
+ * Reads a string that looks like an API call just before the given position in the editor.
+ * An "API call" may include parentheses used to call a function, periods, identifier characters,
+ * and whitespace before and after non-identifiers. Tokens the Ace tokenizer considers to be part of
+ * a string in the editor's current mode also delimit an API call. Comments and line breaks around
+ * non-identifiers are ignored, and string collections continues on the other side of the comment.
+ * Probably mode-independent, though it hasn't been tested on anything besides Python.
+ * @param session - the Ace editing session to use to read the editor contents.
+ * @param pos - the position to start reading behind.
+ * @param minLength - the minimum length in characters of text to read. A whole number of tokens
+ * will always be read, but reading is stopped after reading at least this many characters.
+ * @return The text of the read "API call", which may be an empty string if the first token before
+ * pos is not part of an API call.
+ */
+export default (
+ session: Ace.EditSession,
+ pos: Ace.Position,
+ minLength: number,
+): string => {
+ const iter = new TokenIterator(session, pos.row, pos.column);
+ let token = iter.getCurrentToken();
+ const tokenIsIdent = () =>
+ ['identifier', 'function.support'].includes(token.type);
+ const firstToken = token;
+ while (token === undefined || token.value.trim() === '') {
+ token = iter.stepBackward();
+ if (token === null) {
+ return '';
+ }
+ }
+ if (token.type === 'comment' || token.type === 'string') {
+ return '';
+ }
+ let lastWasIdentifier = tokenIsIdent();
+ let buf = token.value.trim();
+ let posInBuf;
+ if (token === firstToken) {
+ posInBuf = pos.column - iter.getCurrentTokenColumn();
+ } else {
+ posInBuf = buf.length;
+ }
+ buf = buf.slice(0, posInBuf);
+ while (buf.length < minLength) {
+ token = iter.stepBackward();
+ if (token === null) {
+ break;
+ }
+ const tokenIsWhitespace = token.value.trim() === '';
+ // The following conditions cause a token break if coming before an identifier:
+ const preIdentBreak =
+ tokenIsIdent() ||
+ token.type.startsWith('paren') ||
+ token.type === 'string' ||
+ (token.type === 'punctuation' && !token.value.includes('.'));
+ if (lastWasIdentifier && preIdentBreak) {
+ break;
+ }
+ if (token.type !== 'comment') {
+ buf = token.value.trim() + buf;
+ posInBuf += token.value.trim().length;
+ if (!tokenIsWhitespace) {
+ lastWasIdentifier = tokenIsIdent();
+ }
+ }
+ }
+ return buf;
+};
diff --git a/src/renderer/modals/ConfirmModal.tsx b/src/renderer/modals/ConfirmModal.tsx
index 50de41d..1c2ce99 100644
--- a/src/renderer/modals/ConfirmModal.tsx
+++ b/src/renderer/modals/ConfirmModal.tsx
@@ -46,8 +46,7 @@ export default function ConfirmModal({
);
}
/**
- * Default properties for ConfirmModal. Not sure why we need this if we have the default
- * deconstruction parameter but the linter cries if we leave it out.
+ * Default properties for ConfirmModal.
*/
ConfirmModal.defaultProps = {
/**
diff --git a/src/renderer/modals/Modal.tsx b/src/renderer/modals/Modal.tsx
index df52b46..77379a2 100644
--- a/src/renderer/modals/Modal.tsx
+++ b/src/renderer/modals/Modal.tsx
@@ -19,8 +19,8 @@ export default function Modal({
onClose: () => void;
isActive: boolean;
modalTitle: string;
- children: ReactNode;
className?: string;
+ children: ReactNode;
}) {
return (