Synnax 25 RC

[Lham42]

Release Candidate Pull Request Template

Key Information

• Platform Version: 0.25.0

Versioning

Public Packages

Version Consistency

I have verified that the following packages have the same minor version number:

• x/ts
• alamos/ts
• freighter/ts
• client/ts
• alamos/py
• freighter/py
• client/py
• synnax server
• console
• root package.json file

Version Conflicts

I have verified that, when released, the following packages will not conflict with any
previously released packages:

• x/ts
• alamos/ts
• freighter/ts
• client/ts
• alamos/py
• freighter/py
• client/py
• synnax server
• console

CI Tests

• I have verified that all CI tests pass.

CD Builds

• I have verified that all CD builds pass.

User Documentation

Content Changes

I have verified that user facing documentation for each of the following services has
been updated to match any changes in the release candidate. If not, I will note why
the documentation has been left stale.

• reference/concepts
• references/cluster
• references/python-client
• references/typescript-client
• references/console
• references/device-drivers/opcua
• references/device-drivers/ni

Examples

I have verified that code examples for each of the following services run correctly:

• client/py
• client/ts

Console

Auto Update

• I have verified that the nightly builds of the Console are able to auto-update correctly.

Cluster Connection

I can successfully:

• Connect to a cluster.
• Disconnect from a cluster.
• Switch clusters in the selector.
• Remove a cluster.
• Rename a cluster.

Ranges

I can successfully:

• Create a new local range.
• Create a new persisted range.
• Save a local range to Synnax.
• Switch the active range.
• Load a range from the search bar.
• Create a range from a line plot selection.
• Delete a range in the resources view.
• Delete multiple ranges in the resources view.
• Rename a range from the range toolbar.

Channels

I can successfully:

• Create a new channel from the search bar.
• Rename a channel in the resources view.
• Delete a channel in the resources view.
• Delete multiple channels in the resources view.
• Set the alias for a channel under a range.
• Clear the alias for a channel uner a range.

Line Plots

I can successfully:

• Create a new line plot from the mosaic.
• Move the line plot to a new mosaic.
• Create a new line plot from the search bar.
• Plot a historical range of data.
• Plot a live range of data.
• Move channels between axes.
• Adjust the thickness of a line.
• Re-label a line.
• Set the title of the plot.

Schematics

I can successfully:

• Create a new schematic from the mosaic.
• Move the schematic to a new mosaic.
• Create a new schematic from the search bar.
• Add a value to the schematic and display live data.
• Add a valve to the schematic and actuate it.

Workspaces

I can successfully:

• Create a new workspace.
• Switch workspaces in the selector.
• Switch workspaces in the resources view.
• Delete a workspace in the resources view.
• Create a new line plot in a workspace.
• Create a new schematic in a workspace.
• Rename a line plot in a workspace.
• Rename a schematic in a workspace.
• Delete a line plot in a workspace.
• Delete a schematic in a workspace.
• Create a workspace in a previous version of Synnax, add visualizations, and open
  it in the release candidate.

Resources

I can successfully:

• Create a new group and move resources to it.
• Move resources between groups.
• Rename a group.
• Delete a group.

OPC UA

Configuration

I can successfully:

• Connect to an OPC UA server running unencrypted.
• Connect to an OPC UA server running encrypted.
• Create additional sampling groups and move channels to them.
• Create additional channels and move them to existing sampling groups.
• Move and rename channels.
• Save the device configuration.

Read Task

I can successfully:

• Single Sampling - Read from multiple channels.
• Single Sampling - Auto-generate timestamps on the driver.
• Single Sampling - Read timestamps from the OPC UA server.
• Array Sampling - Read from multiple channels in array-sampling mode.
• Array Sampling - Auto-generate timestamps on the driver.
• Array Sampling - Read timestamps from the OPC UA server.
• Array Sampling - The driver will not crash if I specify an improper array size.
  -[ ] Channel Selection - The read task dialog will recommend synnax channels based on
  the configured OPC UA node.

National Instruments

Configuration

I can successfully:

• Recognize and connect to a National Instruments device available on local machine.
• Recognize and connect to a National Instruments devices available on network.
• Recognize and connect to physcial and simulated devices.
• Save device configuration.
• Not see chassis devices connected to the machine
• See devices connected to a chassis

Read Task

I can successfully:

• Plot live data from an analog read task.
• Plot live data from a digital read task.
• Stop, start and reconfigure task at will.
• Disconnect a device while tasks are active and provide meaningful feedback in the task dialogue.
• Begin several tasks at different times and see them all plotting live data.
• Enable and disable data saving at will.

Special Purpose Channels

• Succesfully configure and run an analog read task for each of the following channels
  • Acceleration
  • Acceleration 4 wire
  • Bridge
    • All bridge configurations
  • Charge
  • Current
  • Force bridge polynomial
  • Force bridge table
  • Force bridge two point linear
  • Force iepe
  • Microphone
  • Pressure bridge polynomial
  • Pressure bridge table
  • Pressure bridge two point linear
  • Resistance
  • RTD
    • All RTD types.
    • All resistance configs.
  • Strain gauge
    • all strain guage configurations.
  • Built in temperature sensor
  • Thermocouple
    • All thermocouple types.
    • All cjc options.
  • Torque bridge polynomial
  • Torque bridge table
  • Torque bridge two point linear
  • Velocity iepe
  • Voltage
    • All terminal configurations.
• I can sucessfully configure the following scales:
  • Linear
  • Map

Write Task

I can successfully:

• Begin a digital write task and perform control actions with a schematic.
• Stop, start and reconfigure task at will.
• Disconnect a device while tasks are active and provide meaningful feedback in the task dialogue.
• Configure response time based on state rate specified
  • 1 Hz (should have visible delay in response)
  • 20 Hz (should feel almost immediate)

General Usage

I can successfully:

• Run multiple types of tasks on a single device
• Run multiple tasks across multiple devices simultaneously
• I can reliably stream data at the following sample rates
  = [ ] 1 Hz
  • 10 Hz
  • 50 Hz
  • 100 Hz
  • 500 Hz
  • 1 kHz
  • 2 kHz
  • 5 kHz
• configure the following stream rates
  • 1 Hz
  • 5 Hz
  • 10 Hz
  • 20 Hz
  • 30 Hz

Error Handling

I can successfully:

• Pass in an invalid device configuration and receive meaningful feedback.
  • Invalid ports
  • Invalid task type for devices (e.g. analog read on a analog output device)
  • Out of range values
  • Multiple tasks using the same channel

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 18, 2024 6:23am

[codecov]

Codecov Report

Attention: Patch coverage is 25.43720% with 469 lines in your changes missing coverage. Please review.

Project coverage is 51.45%. Comparing base (06d29ee) to head (96f3a4c).
Report is 1 commits behind head on main.

Files	Patch %	Lines
pluto/src/vis/diagram/aether/types.ts	0.00%	130 Missing ⚠️
pluto/src/vis/schematic/Forms.tsx	0.00%	72 Missing ⚠️
pluto/src/vis/render/performance.ts	0.00%	59 Missing and 1 partial ⚠️
pluto/src/icon/Icon.tsx	0.00%	43 Missing and 1 partial ⚠️
pluto/src/vis/lineplot/aether/LinePlot.ts	0.00%	27 Missing ⚠️
pluto/src/tree/Tree.tsx	0.00%	17 Missing ⚠️
pluto/src/vis/line/aether/line.ts	67.39%	15 Missing ⚠️
pluto/src/modal/Modal.tsx	0.00%	11 Missing ⚠️
pluto/src/vis/lineplot/aether/YAxis.ts	0.00%	11 Missing ⚠️
cesium/writer.go	46.66%	7 Missing and 1 partial ⚠️
... and 24 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #730      +/-   ##
==========================================
- Coverage   51.83%   51.45%   -0.39%     
==========================================
  Files        1048     1050       +2     
  Lines       79487    80648    +1161     
  Branches     3316     3285      -31     
==========================================
+ Hits        41206    41500     +294     
- Misses      37277    38135     +858     
- Partials     1004     1013       +9     

Flag	Coverage Δ
aspen	50.25% <ø> (+0.06%)	⬆️
cesium	75.98% <59.09%> (+1.21%)	⬆️
clientpy	81.97% <ø> (ø)
clientts	87.07% <75.00%> (+0.14%)	⬆️
drift	33.23% <33.33%> (-0.11%)	⬇️
freightergo	26.79% <ø> (+0.23%)	⬆️
freighterpy	77.81% <ø> (ø)
freighterts	80.33% <ø> (ø)
gox	58.78% <ø> (+0.14%)	⬆️
pluto	45.15% <22.43%> (-1.46%)	⬇️
synnax	28.73% <ø> (+1.64%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.