lightningDeviceSDK

LightningDevicesDK允许硬件制造商和研究人员将其数据含水设备连接到LabChart Lightning。这是通过使用使用插件软件的Typescript。

该存储库不提供任何功能，仅提供示例文件和键入接口。您将需要具有有效许可证的Labchart Lightning，以便运行设备插件并连接设备。

Get LabChart Lightning。当您处于插件的设置阶段时，请利用我们的30天试用版。

Find out more。与LabChart Lightning集成的好处以及可以增强促销和销售增长机会的选择。

Tell us about yourself。If you would like notifications regarding new resources and opportunities, such as promoting your device to researchers, then please fill out our contact form.

**The LightningDeviceSDK is currently under development and is subject to change.**

Supported Device Classes

• Serial
• Bluetooth over Serial (Serial Port Profile)
• More to come...

Change Log

SeeChangelog。

Upcoming Features

• Better than 10 microsecond inter-device synchronization over USB for Microchip ARM SAMD51 and SAMD21 based devices (e.g. Adafruit Feather M4, M0 etc. and Sparkfun Thing+ SAMD51)
• Calling arbitrary proxy functions from custom UI
• Plugins work for non-admin users
• Better error messaging

开始

最低要求

• labChart Lightning
• A text editor

Recommended Device Development Workflow and Initial Setup

When starting out, it is useful to be able to detect possible device implementation errors early, plus make and test improvements rapidly. Therefore, it is strongly recommended to do the following.

Install the needed dependencies:

• Node.js -https://nodejs.org/en/download/
• Visual Studio Code -https://code.visualstudio.com/download
  • Install VS Code extension: ESLint

If you're developing Arduino firmware:

• Arduino IDE -https://www.arduino.cc/en/Main/Software
  • Arduino core(s) for the intended board(s)
  • 为了获得USB设备之间的最佳时间同步，我们建议基于SAM51的板，例如（例如Adafruit Feather M4等，Sparkfun Thing+ SAMD51）
  • Optionally, the Arduino extension for Visual Studio Code
  • firmware examples for several boards exist inexamples\firmware。

Clone this repo to your working environment

At the command line, install packages that will assist with development:

$ npm install

Note:npmis the Node Package Manager which comes with Node.js and should already be installed with the steps above.

If you are using Visual Studio Code you can open a terminal from the终端menu:

然后运行npm install:

In order for your plugin file to be loaded by Lightning it must be placed into the following location:

(Windows)
C:\Users\[USERNAME]\Documents\LabChart Lightning\Plugins\Devices

(MacOS)
~/Documents/LabChart Lightning/Plugins/devices

However, to speed up development you can instead work within your current location. Focusing in on the top left of VS Code you also can see an explorer button. Clicking on that button will allow you to see the structure of the project, and in particular, the。/development/目录中。

The above image shows the path to an example device plugin file:

。/development/devices/Device/Device.ts

Then runnpm run watchin your terminal.

npm run watch

这是任何更改的.js或者。tsfiles located under。/development/, automatically copying the updated file(s) to the above mentioned文档/LabChart Lightning/插件/目录中。In this way you an see the resulting changes as early as possible, and therefore speed up development.

Note: LabChart Lightning must be relaunched to re-compile device plugin files.

More Setup Steps

Here, you can go a little deeper and make sure that your plug-in file is being detected, and that you can find compilation errors.

Overview

设定了环境后，您将需要一个overviewof the requirements for a device plug-in file.

Advanced Topics

Runtime debuggingyour device script.

Customizing Lightning'suser interfacefor your device.

Inter-device time synchronizationtime synch。

license

BSD 3-Clause Clear