Getting Started: Difference between revisions

From SweepMe! Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Last update for: Version 1.5.4.x
Last update for Version 1.5.6.x


== Download ==
We recommend to visit our [https://www.youtube.com/channel/UCBMjpLyLgmcrq9vbvxMDSww SweepMe! YouTube channel] where a series of 'Basics' videos explains the handling of SweepMe!.
* Download SweepMe! here [https://sweep-me.net/download/]
* A [[WebInstaller]] will be downloaded, start it and just press download to get the latest stable version.


== Installation ==
== Installation ==
* If you have used the webinstaller, the real installer of SweepMe! will automatically start.
* Use the recommended path ("C:\SweepMe!) to simplify later version handling and migration


== First start ==
* Access SweepMe! [https://sweep-me.net/download/] to download and run the [[WebInstaller]].
* Start SweepMe!.exe, e.g. by using the link on the desktop
* For versions 1.5.5 and earlier, use the recommended path ("C:\SweepMe!") for simpler future handling and migration.
* Accept or decline a server connection
* Starting from version 1.5.6, support for [[Unattended Installation|unattended installations]] is available.
* Create a profile that stores your options and that creates a folder for your measurement data
 
== Setting up SweepMe! ==
 
* Launch SweepMe!.exe, e.g., via the desktop link.
* Accept or decline a server connection.
* Create a profile to save your settings and establish a folder for your measurement data.
 
== Basics ==
 
* SweepMe! has two important tabs: [[General]] and [[Sequencer]].
* The Measurement tab allows the selection of a user profile and data saving.
* The Sequencer tab is where the magic happens. Here, measurement procedures are designed and set up.
* The elements in the sequencer are called [[Modules]]. There are basic modules such as [[Loop]] or [[Hold]], and [[Devices | device modules]] that communicate with external hardware.
* Learn more about the sequencer tree structure at the [[Sequencer]] page.


== First run ==
== First run ==
* A preconfigured measurement can be instantly started without the need to connect any equipment
* Just press run after the very first start of SweepMe!
* Other examples can be loaded via ''[[Settings]]'' -> ''Load example''
* Play around with the Plot and see how it is connected to the [[sequencer]]


== Basics ==
* A preconfigured example measurement without the need for additional hardware is set up after the first SweepMe! launch.
* SweepMe! has two important tabs [[General]] and [[Sequencer]]
* Test this ''Mouse Logger'' by pressing run. Watch as the mouse courser position is mapped in the [[Plot]] window of the dashboard.
* The Measurement tab allows you to choose a user and save your data.
* The plot parameters can be changed by double-clicking into the plot window.
* The Sequencer tab is where the magic takes place. Use it to setup your measurement.
* Explore additional examples through ''[[Settings]]'' -> ''Load example''.
* Important folders, e.g. where your measurement data is, can be found via ''File'' -> ''Open Folder'' -> ''Measurement Data''
 
== Saving data ==
 
* SweepMe! automates the creation and filling of data files using the [[MakeFile]] module in the sequencer.
* Data is always saved in the Measurement folder, accessible through ''File'' -> ''Open Folder'' -> ''Measurement Data''.
* Enter the folder and file name in the 'General' tab and press "Save Data".
 
== Creating your own Measurements ==
 
* Download additional [[Modules]] or [[Devices]] via the 'Tools' menu -> [[Version manager|Modules&Devices]].
* Add devices to the sequencer via drag and drop of the corresponding module. E.g. devices that read values use the [[Logger]] module, while devices that set values use [[Switch]].
* Set up the device parameter in the tab that is newly generated. Check whether you are ready to use device communication via [[GPIB]], [[USB]], and [[COM]].
* Add [[Widgets]] such as [[Plot]], [[Monitor]], [[Image]], [[Notes]] to the [[Dashboard]] to display your measurement results.
* Save your configuration, including sequencer settings, dashboard layout, and widget setups, as a unified [[Settings|setting]]. This makes it easy to reproduce your measurements later.
 
== Next Steps ==


== Customization ==
* Dive deeper into the functionality of the [[Sequencer]].
* Check whether you are ready to use device communication via [[GPIB]], [[USB]], and [[COM]]
* Explore the range of supported devices on [https://sweep-me.net/modules_devices our webpage].
* Download [[Modules]] or [[Devices]] via the menu 'Tools' -> [[Version manager|Modules&Devices]]
* Did not find the device that you need? [https://sweep-me.net/services/overview Contact us] or program your own [[Driver_Programming | device driver]].
* Use the [[Version manager]] to activate and deactivate content to see eactly those modules that you can use at your setup.
* Add [[Widgets]] to your measurement via the menu 'Widgets' to the [[Dashboard]]
* Widgets such as [[Plot]], [[Monitor]], [[Image]], [[Notes]] can be created before and during a measurement.

Latest revision as of 12:05, 25 March 2024

Last update for Version 1.5.6.x

We recommend to visit our SweepMe! YouTube channel where a series of 'Basics' videos explains the handling of SweepMe!.

Installation

  • Access SweepMe! [1] to download and run the WebInstaller.
  • For versions 1.5.5 and earlier, use the recommended path ("C:\SweepMe!") for simpler future handling and migration.
  • Starting from version 1.5.6, support for unattended installations is available.

Setting up SweepMe!

  • Launch SweepMe!.exe, e.g., via the desktop link.
  • Accept or decline a server connection.
  • Create a profile to save your settings and establish a folder for your measurement data.

Basics

  • SweepMe! has two important tabs: General and Sequencer.
  • The Measurement tab allows the selection of a user profile and data saving.
  • The Sequencer tab is where the magic happens. Here, measurement procedures are designed and set up.
  • The elements in the sequencer are called Modules. There are basic modules such as Loop or Hold, and device modules that communicate with external hardware.
  • Learn more about the sequencer tree structure at the Sequencer page.

First run

  • A preconfigured example measurement without the need for additional hardware is set up after the first SweepMe! launch.
  • Test this Mouse Logger by pressing run. Watch as the mouse courser position is mapped in the Plot window of the dashboard.
  • The plot parameters can be changed by double-clicking into the plot window.
  • Explore additional examples through Settings -> Load example.

Saving data

  • SweepMe! automates the creation and filling of data files using the MakeFile module in the sequencer.
  • Data is always saved in the Measurement folder, accessible through File -> Open Folder -> Measurement Data.
  • Enter the folder and file name in the 'General' tab and press "Save Data".

Creating your own Measurements

  • Download additional Modules or Devices via the 'Tools' menu -> Modules&Devices.
  • Add devices to the sequencer via drag and drop of the corresponding module. E.g. devices that read values use the Logger module, while devices that set values use Switch.
  • Set up the device parameter in the tab that is newly generated. Check whether you are ready to use device communication via GPIB, USB, and COM.
  • Add Widgets such as Plot, Monitor, Image, Notes to the Dashboard to display your measurement results.
  • Save your configuration, including sequencer settings, dashboard layout, and widget setups, as a unified setting. This makes it easy to reproduce your measurements later.

Next Steps

Retrieved from "https://wiki.sweep-me.net/index.php?title=Getting_Started&oldid=5399"