bossdevice API for MATLAB

Versión 0.12.0 (62,4 MB) por Pablo
sync2brain's bossdevice RESEARCH Application Programmable Interface (API) for MATLAB.
54 descargas
Actualizado 15 abr 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

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.
  3. 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 -LocalPort 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. Start MATLAB and install the bossdevice API toolbox with double click on bossdevice-api-installer.mltbx.
  3. 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.
  4. 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. Click on the update command if prompted to update the software dependencies on the bossdevice.
  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.

Citar como

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

Compatibilidad con la versión de MATLAB
Se creó con R2023b
Compatible con cualquier versión desde R2022b
Compatibilidad con las plataformas
Windows macOS Linux

Community Treasure Hunt

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

Start Hunting!

dependencies/+bossapi

dependencies/+bossapi/+boss

dependencies/+bossapi/+inst

dependencies/+bossapi/+plotutils

dependencies/+bossapi/+settings

dependencies/+bossapi/+sg

dependencies/+bossapi/+tg

dependencies/+bossapi/+tg/private

dependencies/sg/+speedgoat

dependencies/sg/+speedgoat/+internal

dependencies/sg/+speedgoat/+model

examples

html

src

Versión Publicado Notas de la versión
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.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.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.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.0.0

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

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

Para consultar o notificar algún problema sobre este complemento de GitHub, visite el repositorio de GitHub.
Para consultar o notificar algún problema sobre este complemento de GitHub, visite el repositorio de GitHub.