Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add workflow and page for MemoryUsageDevice #51

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Add workflow and page for MemoryUsageDevice #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions source/Hardware Guide/Datasheets/memory-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Register Programming
- None
- Number of 32-bit words stored in memory, same value as what the frames generate

.. _onidatasheet_memory-usage_d2h:

Device To Host Data Frames
******************************************
Each frame transmitted to the host is structured as follows:
Expand Down
52 changes: 52 additions & 0 deletions source/Software Guide/Bonsai.ONIX/Nodes/MemoryUsageDevice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@


#################
MemoryUsageDevice
#################


A `Bonsai source <https://bonsai-rx.org/docs/editor/#toolbox>`__ that wraps a
:ref:`onidatasheet_memory-usage` device.

:Inputs: None
:Outputs: A single ``MemoryUsageDataFrame`` that is produced periodically by
hardware containing information about data buffer memory status.
This type is a wrapper around the :ref:`Device To Host Data Frame <onidatasheet_memory-usage_d2h>` specified
on the :ref:`onidatasheet_memory-usage` datasheet. To calculate the percentage of memory that is occupied,
divide the number of 32-bit memory words used by the hardware's total memory and multiply that quotient by 100.

.. attention::
The :ref:`Block Read Size <bonsai_onicontext_configuration>` property in the :ref:`bonsai_onicontext` node is set intentionally low so that the buffer accumulates data for demonstration purposes.

.. raw:: html

{% with static_path = '../../../_static', name = 'MemoryMonitor' %}
{% include 'workflow.html' %}
{% endwith %}

*************
Configuration
*************

Configuration is performed using its property pane which contains the following
options.

.. list-table::
:widths: auto
:header-rows: 1

* - Name
- Type
- Description

* - EnableStream
- boolean
- Enable the device data stream

* - UpdateHz
- uint
- Rate at which the hardware memory usage is polled in Hz.

* - MemorySize
- uint
- Hardware buffer size in 32-bit words.
6 changes: 4 additions & 2 deletions source/Software Guide/Bonsai.ONIX/Nodes/ONIContext.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ to use it.
present in a single computer, then each will need its own
:ref:`bonsai_onicontext` to manage it.

.. _bonsai_onicontext_configuration:

Configuration GUI
--------------------------
:ref:`bonsai_onicontext` configuration is performed using a GUI provided in the
Expand All @@ -80,10 +82,10 @@ using the **Properties Pane** on the right side of the form.
#. **Settings**: Drop down menu that provides several hardware configuration options
#. **Driver**: The device driver used to control the host hardware.
#. **Slot**: The physical slot of the Host hardware in the computer.
#. **Read Block Size**: The number of bytes read per call to the kernel driver.
#. **Block Read Size**: The number of bytes read per call to the kernel driver.
Larger numbers *will generally* increase overall bandwidth and decrease
response latency.
#. **Write Block Size**: The number of bytes pre-allocated to make output for output
#. **Block Write Size**: The number of bytes pre-allocated to make output for output
data frames. Larger numbers *may* increase overall bandwidth and decrease
response latency.
#. |refresh_icon| **<status>**: Shows the current host hardware connection status.
Expand Down
1 change: 1 addition & 0 deletions source/Software Guide/Bonsai.ONIX/Nodes/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Nodes

ONIContext
HeartbeatDevice
MemoryUsageDevice
AnalogIODevice
DigitalIODevice
ClockOutputDevice
Expand Down
116 changes: 116 additions & 0 deletions source/_static/bonsai/workflows/MemoryMonitor.bonsai
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<?xml version="1.0" encoding="utf-8"?>
<WorkflowBuilder Version="2.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:p1="clr-namespace:Bonsai.ONIX;assembly=Bonsai.ONIX"
xmlns:dsp="clr-namespace:Bonsai.Dsp;assembly=Bonsai.Dsp"
xmlns:io="clr-namespace:Bonsai.IO;assembly=Bonsai.System"
xmlns="https://bonsai-rx.org/2018/workflow">
<Workflow>
<Nodes>
<Expression xsi:type="Combinator">
<Combinator xsi:type="p1:ONIContext">
<p1:ContextConfiguration>
<p1:Slot>
<p1:Driver>riffa</p1:Driver>
<p1:Index>0</p1:Index>
</p1:Slot>
<p1:ReadSize>48</p1:ReadSize>
<p1:WriteSize>8192</p1:WriteSize>
</p1:ContextConfiguration>
</Combinator>
</Expression>
<Expression xsi:type="Combinator">
<Combinator xsi:type="p1:AnalogIODevice">
<p1:DeviceAddress>
<p1:HardwareSlot>
<p1:Driver>riffa</p1:Driver>
<p1:Index>0</p1:Index>
</p1:HardwareSlot>
<p1:Address>6</p1:Address>
</p1:DeviceAddress>
<p1:BlockSize>100</p1:BlockSize>
<p1:DataType>Volts</p1:DataType>
<p1:EnableStream>true</p1:EnableStream>
<p1:InputRange00>TenVolts</p1:InputRange00>
<p1:InputRange01>TenVolts</p1:InputRange01>
<p1:InputRange02>TenVolts</p1:InputRange02>
<p1:InputRange03>TenVolts</p1:InputRange03>
<p1:InputRange04>TenVolts</p1:InputRange04>
<p1:InputRange05>TenVolts</p1:InputRange05>
<p1:InputRange06>TenVolts</p1:InputRange06>
<p1:InputRange07>TenVolts</p1:InputRange07>
<p1:InputRange08>TenVolts</p1:InputRange08>
<p1:InputRange09>TenVolts</p1:InputRange09>
<p1:InputRange10>TenVolts</p1:InputRange10>
<p1:InputRange11>TenVolts</p1:InputRange11>
<p1:Direction00>Input</p1:Direction00>
<p1:Direction01>Input</p1:Direction01>
<p1:Direction02>Input</p1:Direction02>
<p1:Direction03>Input</p1:Direction03>
<p1:Direction04>Input</p1:Direction04>
<p1:Direction05>Input</p1:Direction05>
<p1:Direction06>Input</p1:Direction06>
<p1:Direction07>Input</p1:Direction07>
<p1:Direction08>Input</p1:Direction08>
<p1:Direction09>Input</p1:Direction09>
<p1:Direction10>Input</p1:Direction10>
<p1:Direction11>Input</p1:Direction11>
</Combinator>
</Expression>
<Expression xsi:type="MemberSelector">
<Selector>Data</Selector>
</Expression>
<Expression xsi:type="Combinator">
<Combinator xsi:type="dsp:MatrixWriter">
<dsp:Path>analog-data_.raw</dsp:Path>
<dsp:Suffix>Timestamp</dsp:Suffix>
<dsp:Overwrite>false</dsp:Overwrite>
<dsp:Layout>ColumnMajor</dsp:Layout>
</Combinator>
</Expression>
<Expression xsi:type="MemberSelector">
<Selector>Clock</Selector>
</Expression>
<Expression xsi:type="Combinator">
<Combinator xsi:type="dsp:MatrixWriter">
<dsp:Path>analog-clock_.raw</dsp:Path>
<dsp:Suffix>Timestamp</dsp:Suffix>
<dsp:Overwrite>false</dsp:Overwrite>
<dsp:Layout>ColumnMajor</dsp:Layout>
</Combinator>
</Expression>
<Expression xsi:type="Combinator">
<Combinator xsi:type="p1:MemoryUsageDevice">
<p1:DeviceAddress>
<p1:HardwareSlot>
<p1:Driver>riffa</p1:Driver>
<p1:Index>0</p1:Index>
</p1:HardwareSlot>
<p1:Address>10</p1:Address>
</p1:DeviceAddress>
<p1:EnableStream>true</p1:EnableStream>
<p1:UpdateHz>100</p1:UpdateHz>
</Combinator>
</Expression>
<Expression xsi:type="io:CsvWriter">
<io:FileName>memory-use_.csv</io:FileName>
<io:Append>false</io:Append>
<io:Overwrite>false</io:Overwrite>
<io:Suffix>Timestamp</io:Suffix>
<io:IncludeHeader>false</io:IncludeHeader>
<io:Selector>Clock,MemoryUsageBytes,MemoryUsagePercentage</io:Selector>
</Expression>
<Expression xsi:type="MemberSelector">
<Selector>MemoryUsagePercentage</Selector>
</Expression>
</Nodes>
<Edges>
<Edge From="1" To="2" Label="Source1" />
<Edge From="1" To="4" Label="Source1" />
<Edge From="2" To="3" Label="Source1" />
<Edge From="4" To="5" Label="Source1" />
<Edge From="6" To="7" Label="Source1" />
<Edge From="7" To="8" Label="Source1" />
</Edges>
</Workflow>
</WorkflowBuilder>
3 changes: 3 additions & 0 deletions source/_static/bonsai/workflows/MemoryMonitor.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.