diff --git a/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/python_code.txt b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/python_code.txt index 8bec0373f8..f4dac53be1 100644 --- a/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/python_code.txt +++ b/docs/nodes/AI_ML/PREDICT_TIME_SERIES/PROPHET_PREDICT/a1-[autogen]/python_code.txt @@ -4,7 +4,7 @@ from flojoy import flojoy, run_in_venv, DataFrame @flojoy @run_in_venv( pip_dependencies=[ - "prophet==1.1.4", + "prophet==1.1.5", ] ) def PROPHET_PREDICT( diff --git a/docs/nodes/IO/PROTOCOLS/CAN/CANABLE/CAN_MESSAGE/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/CAN/CANABLE/CAN_MESSAGE/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..8ed18518fd --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/CAN/CANABLE/CAN_MESSAGE/a1-[autogen]/docstring.txt @@ -0,0 +1,17 @@ +The CAN_MESSAGE node sends a message onto CAN network through a slcan-compatible USB-to-CAN adapter. + + Inputs + ------ + default: Vector + The array of data to send to the CAN bus. + + Parameters + ---------- + arbitration_id: + Unique ID for message being sent. + is_extended_id: bool + Flag that controls the size of the arbitration_id field. + + Returns + ------- + None diff --git a/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_ADDR/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_ADDR/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..0a108c9064 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_ADDR/a1-[autogen]/docstring.txt @@ -0,0 +1,16 @@ +The PROLOGIX_ADDR node sets the GPIB address of an instrument using the Prologix USB-to-GPIB or USB-to-Ethernet adapter. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + TextBlob + Response from the Prologix USB-to-GPIB controller. diff --git a/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_AUTO/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_AUTO/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..bc574fa77e --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_AUTO/a1-[autogen]/docstring.txt @@ -0,0 +1,18 @@ +The PROLOGIX_AUTO node toggles "Read-After-Write" mode on or off. + + When Read-After-Write is on, the Prologix USB-to-GPIB controller automatically reads a bench-top instrument's response after writing a command to it. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + TextBlob + Response from the Prologix USB-to-GPIB controller. diff --git a/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_HELP/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_HELP/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..0e48a32202 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_HELP/a1-[autogen]/docstring.txt @@ -0,0 +1,16 @@ +The PROLOGIX_HELP command returns a list of available Prologix USB-to-GPIB firmware commands. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + TextBlob + A list of available Prologix USB-to-GPIB firmware commands diff --git a/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_MODE/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_MODE/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..6bc0265178 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_MODE/a1-[autogen]/docstring.txt @@ -0,0 +1,32 @@ +The PROLOGIX_MODE node sets the mode of the Prologix USB-to-GPIB controller - 1 for CONTROLLER mode and 0 for DEVICE mode. + + From the Prologix manual: + + In Controller mode, the GPIB-USB Controller acts as the Controller-In-Charge (CIC) + on the GPIB bus. When the controller receives a command over the USB port + terminated by the USB terminator – CR (ASCII 13) or LF (ASCII 10) – it addresses the + GPIB instrument at the currently specified address (See ++addr command) to listen, and + passes along the received data. + + In Device mode, Prologix GPIB-USB Controller acts as another peripheral on the GPIB + bus. In this mode, the controller can act as a GPIB TALKER or GPIB LISTENER + only. Since Prologix GPIB-USB Controller is not the Controller-In-Charge while in this + mode, it expects to receive commands from a GPIB controller. When Device mode is + enabled Prologix GPIB-USB controller configures itself as a GPIB Listener. All data + received by the controller over the GPIB port is passed along to the USB port without + buffering. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + TextBlob + Response from the Prologix USB-to-GPIB controller. diff --git a/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_VER/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_VER/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..b776214225 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/GPIB/PROLOGIX/PROLOGIX_VER/a1-[autogen]/docstring.txt @@ -0,0 +1,16 @@ +The PROLOGIX_VER command queries the Prologix USB-to-GPIB firmware version. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + TextBlob + The Prologix controller available commands. diff --git a/docs/nodes/IO/PROTOCOLS/SCPI/SCPI_WRITE/a1-[autogen]/docstring.txt b/docs/nodes/IO/PROTOCOLS/SCPI/SCPI_WRITE/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..999209a695 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SCPI/SCPI_WRITE/a1-[autogen]/docstring.txt @@ -0,0 +1,16 @@ +The SCPI_WRITE node writes a SCPI command to a connected bench-top instrument and returns the result. + + Inputs + ------ + default: DataContainer + Any DataContainer - likely connected to the output of the OPEN_SERIAL node. + + Parameters + ---------- + connection: Serial + The open serial connection with the instrument. + + Returns + ------- + Scalar|TextBlob + The return value from the bench-top instrument as a Scalar or TextBlob. diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..cb4bff4fb7 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/docstring.json @@ -0,0 +1,17 @@ +{ + "description": null, + "parameters": [ + { + "name": "device", + "type": "Serial", + "description": "The connected serial device." + } + ], + "returns": [ + { + "name": null, + "type": "TextBlob", + "description": null + } + ] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/python_code.txt b/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/python_code.txt index 267175c76c..87b0c5ddb5 100644 --- a/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/python_code.txt +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/OPEN_SERIAL/a1-[autogen]/python_code.txt @@ -6,15 +6,7 @@ from flojoy.connection_manager import DeviceConnectionManager @flojoy(deps={"pyserial": "3.5"}) def OPEN_SERIAL(device: SerialDevice, baudrate: int = 9600) -> TextBlob: - """The OPEN_SERIAL node opens a serial connection through your computer's USB or RS-232 port. - Parameters - ---------- - device: Serial - The connected serial device. - Returns - ------- - TextBlob - """ + ser = serial.Serial( port=device.get_port(), @@ -27,4 +19,4 @@ def OPEN_SERIAL(device: SerialDevice, baudrate: int = 9600) -> TextBlob: DeviceConnectionManager.register_connection(device, ser) - return TextBlob(text_blob=json.dumps(ser.get_settings())) \ No newline at end of file + return TextBlob(text_blob=json.dumps(ser.get_settings())) diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..b1d987e054 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_SINGLE_MEASUREMENT/a1-[autogen]/docstring.json @@ -0,0 +1,16 @@ +{ + "description": null, + "parameters": [ + { + "name": "baudrate", + "type": "int", + "description": "Baud rate for the serial communication." + }, + { + "name": "comport", + "type": "string", + "description": "Defines the comunication port on which the serial device is connected." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_TIMESERIES/a1-[autogen]/docstring.json b/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_TIMESERIES/a1-[autogen]/docstring.json new file mode 100644 index 0000000000..bbf5c0d639 --- /dev/null +++ b/docs/nodes/IO/PROTOCOLS/SERIAL/SERIAL_TIMESERIES/a1-[autogen]/docstring.json @@ -0,0 +1,31 @@ +{ + "description": null, + "parameters": [ + { + "name": "num_readings", + "type": "int", + "description": "Number of points to record." + }, + { + "name": "record_period", + "type": "float", + "description": "Length between two recordings in seconds." + }, + { + "name": "baudrate", + "type": "int", + "description": "Baud rate for the serial device." + }, + { + "name": "comport", + "type": "string", + "description": "COM port of the serial device." + }, + { + "name": "num_readings * record_period", + "type": "", + "description": "Is roughly the run length in seconds." + } + ], + "returns": [] +} \ No newline at end of file diff --git a/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_PAIR_2_VECTOR/a1-[autogen]/docstring.txt b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_PAIR_2_VECTOR/a1-[autogen]/docstring.txt new file mode 100644 index 0000000000..e51e43393c --- /dev/null +++ b/docs/nodes/TRANSFORMERS/TYPE_CASTING/ORDERED_PAIR_2_VECTOR/a1-[autogen]/docstring.txt @@ -0,0 +1,11 @@ +The ORDERED_PAIR_2_VECTOR return the y component of an ordered pair as a Vector. + + Inputs + ------ + default : OrderedPair + The input OrderedPair. + + Returns + ------- + Vector + The y component of the input OrderedPair. diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.txt b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.txt index 8db9cc3153..d091fba5f9 100644 --- a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.txt +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/docstring.txt @@ -3,9 +3,14 @@ The TEXT_VIEW node creates a text visualization for a given TextBlob DataContain Inputs ------ default : TextBlob - the DataContainer to be visualized in text format + The DataContainer to be visualized in text format + + Parameters + ---------- + prettify : Boolean + Whether to prettify the displayed text (defaults to True) Returns ------- TextBlob - the DataContainer containing text data + The DataContainer containing text data diff --git a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/python_code.txt b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/python_code.txt index 16cd9891c1..7b3dc82392 100644 --- a/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/python_code.txt +++ b/docs/nodes/VISUALIZERS/DATA_STRUCTURE/TEXT_VIEW/a1-[autogen]/python_code.txt @@ -1,8 +1,14 @@ +import pprint from flojoy import flojoy, TextBlob @flojoy -def TEXT_VIEW(default: TextBlob): +def TEXT_VIEW(default: TextBlob, prettify: bool = False) -> TextBlob: - return default + s = default.text_blob + + if prettify: + s = pprint.pformat(default.text_blob) + + return TextBlob(s) diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/python_code.txt b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/python_code.txt index fe06484623..b1292fcfdf 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/python_code.txt +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_COMPONENTS/a1-[autogen]/python_code.txt @@ -4,7 +4,7 @@ from flojoy import flojoy, run_in_venv, DataFrame, Plotly @flojoy @run_in_venv( pip_dependencies=[ - "prophet==1.1.4", + "prophet==1.1.5", ] ) def PROPHET_COMPONENTS(default: DataFrame, periods: int = 365) -> Plotly: diff --git a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/python_code.txt b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/python_code.txt index ac73a36a76..b232e3a237 100644 --- a/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/python_code.txt +++ b/docs/nodes/VISUALIZERS/PLOTLY/PROPHET_PLOT/a1-[autogen]/python_code.txt @@ -4,7 +4,7 @@ from flojoy import flojoy, run_in_venv, DataFrame, Plotly @flojoy @run_in_venv( pip_dependencies=[ - "prophet==1.1.4", + "prophet==1.1.5", ] ) def PROPHET_PLOT(default: DataFrame, periods: int = 365) -> Plotly: diff --git a/nodeSidebar.json b/nodeSidebar.json index 31033e3fb9..754a27cffa 100644 --- a/nodeSidebar.json +++ b/nodeSidebar.json @@ -191,7 +191,6 @@ "nodes/IO/INSTRUMENTS/OSCILLOSCOPES/TEKTRONIX/MDO3XXX/BASIC/TRIGGER_LEVEL_MDO3XXX/TRIGGER_LEVEL_MDO3XXX" ], "I/O > Protocols": [ - "nodes/IO/PROTOCOLS/CAN/CAN", "nodes/IO/PROTOCOLS/SCPI/IDN/IDN", "nodes/IO/PROTOCOLS/SCPI/MEASURE_VOLTAGE/MEASURE_VOLTAGE", "nodes/IO/PROTOCOLS/SERIAL/BASIC/OPEN_SERIAL/OPEN_SERIAL",