bossdevice API for MATLAB

Version 0.14.1 (10.5 MB) by Pablo
sync2brain's bossdevice RESEARCH Application Programmable Interface (API) for MATLAB.
65 Downloads
Updated 26 Jun 2024

sync2brain's bossdevice RESEARCH Application Programmable Interface (API) for MATLAB

CI GitHub issues by-label GitHub View bossdevice-api-matlab on File Exchange Open in MATLAB Online

Requirements

Optional

The following products are required for some advanced functionality such as designing custom filters but are not strictly required for a standard operation or triggering of the bossdevice.

Enable bossdevice communication over Control PC

  1. Turn on the bossdevice and connect the Control PC Ethernet port on your bossdevice to an available Ethernet port on your computer.
  2. On your computer, follow these steps to configure the local Ethernet interface on your PC with the IP address 192.168.7.2.

Optional

If you cannot connect to the bossdevice facing message errors like Error: Cannot connect to target 'bossdevice': Cannot connect to target. or experience frequent disconnection issues, please check out the following recommended steps.

  1. If you are working on Windows, ensure a stable and robust connection between the development PC and the bossdevice:
    • Set the Development-to-Target Computer Ethernet Interface as Private. Please, follow the steps documented here.
    • If you are not allowed by the IT security settings in your company or institution to change the Ethernet Interface's profile or the Development-to-Target Computer Ethernet Interface keeps reverting to Public after some time or even after every system's reboot, please run PowerShell with administrator rights, and execute the command New-NetFirewallRule -DisplayName "bossdevice" -Direction Inbound -RemotePort 5505-5507,5510-5512,5515-5517 -Protocol UDP -Action Allow -Profile Any -RemoteAddress 192.168.7.5. See reference.

Installation and initial toolbox configuration

  1. Download bossdevice-api-installer.mltbx from the latest release available in the GitHub project.
  2. Download the bossdevice firmware binary file for your MATLAB Release from our downloads portal.
  3. Start MATLAB and install the bossdevice API toolbox with double click on bossdevice-api-installer.mltbx.
  4. In the MATLAB Command Window, call bd = bossdevice to add the bossdevice with the default settings to the list of targets. If you want to change either the name of the bossdevice or its default IP address in your local MATLAB settings, call bd = bossdevice('bossdevice','192.168.7.5') replacing the function arguments with the name and IP address you want to set on the real-time device.
  5. When prompted, select the bossdevice firmware binary file with the mldatx extension you have downloaded above. Please note you may run bd.installFirmwareOnToolbox afterwards to copy the firmware file into your local toolbox folder, so that you can skip this step in later sessions.
  6. Open the documentation openBossdeviceDoc or bd.doc.

Optionally, for more information about how to get, install and manage add-ons for MATLAB like the bossdevice API toolbox, please visit this documentation page.

Get started

  1. Create an instance of the main control class bossdevice bd = bossdevice in the MATLAB command window from any working path, since the toolbox has already been added to your MATLAB path.
  2. If not found in the MATLAB path or you want to use a custom firmware version, please select mainmodel.mldatx real-time application.
  3. Initialize the bossdevice with bd.initialize.
  4. If your version of the bossdevice does not match your current version of MATLAB, you may get a Target computer software version mismatch error. In that scenario, please simply click on the underlined update(tg) command. The bossdevice hardware will be upgraded automatically. After some seconds, you can rerun bd.initialize.
  5. Run the signal processing application on the remote device with bd.start in the MATLAB command window.
  6. Open the documentation openBossdeviceDoc and explore examples with demo_script_name and methods available in the bossdevice object.

User manual

Visit our online documentation available here.

Download and install the toolbox in MATLAB for a complete access to the user manual with the command openBossdeviceDoc in the MATLAB console. You will find more details about API properties and methods, example scripts and further technical information.

Feedback, questions and troubleshooting

If you have any issue to report or enhancement to request, please create a new Issue. If you have any other topic to discuss like a question about usage, a tip to share with the community or other topic of interest, please check out our on-going Discussions.

Cite As

Pablo (2024). bossdevice API for MATLAB (https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.14.1), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2024a
Compatible with R2024a and later releases
Platform Compatibility
Windows macOS Linux

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Version Published Release Notes
0.14.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.14.1

0.14.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.14.0

0.13.4

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.13.4

0.13.3

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.13.3

0.13.2

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.13.2

0.13.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.13.1

0.12.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.12.0

0.11.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.11.1

0.11.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.11.0

0.10.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.10.1

0.10.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.10.0

0.9.9

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.9

0.9.8

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.8

0.9.7

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.7

0.9.6

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.6

0.9.5

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.5

0.9.4

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.4

0.9.3

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.3

0.9.2.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.2

0.9.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.1

0.9.0.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.9.0

0.8.3.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.8.3

0.8.2

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.8.2

0.8.1.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.8.1

0.8.0.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.8.0

0.7.4

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.7.4

0.7.3.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.7.3

0.7.2.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.7.2

0.7.1.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.7.1

0.7.0.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.7

0.6.5.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.6.5

0.6.1.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.6.1

0.6.0.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.6

0.5.2.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.5.2

0.5.1

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.5.1

0.5.0.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.5

0.4

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.4

0.3.4.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.3.4

0.3.3.0

See release notes for this release on GitHub: https://github.com/sync2brain/bossdevice-api-matlab/releases/tag/v0.3.3

0.3.2

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.