Skip to content

Commit

Permalink
[docs/device-drivers] add labjack dir to see if it builds
Browse files Browse the repository at this point in the history
  • Loading branch information
Lham42 committed Nov 4, 2024
1 parent 1a983cf commit 51093b2
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/site/src/pages/reference/device-drivers/labjack/_nav.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright 2024 Synnax Labs, Inc.
//
// Use of this software is governed by the Business Source License included in the file
// licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with the Business Source
// License, use of this software will be governed by the Apache License, Version 2.0,
// included in the file licenses/APL.txt.

import { type PageNavNode } from "@/components/PageNav/PageNav";

export const niNav: PageNavNode = {
key: "labjack",
name: "LabJack",
children: [
{
key: "/reference/device-drivers/labjack/get-started",
href: "/reference/device-drivers/labjack/get-started",
name: "Get Started",
},
{
key: "/reference/device-drivers/labjack/configure-device",
href: "/reference/device-drivers/labjack/configure-device",
name: "Configure a Device",
},
{
key: "/reference/device-drivers/labjack/read-task",
href: "/reference/device-drivers/labjack/read-task",
name: "Read Task",
},
{
key: "/reference/device-drivers/labjack/write-task",
href: "/reference/device-drivers/labjack/write-task",
name: "Write Task",
},
],
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
layout: "@/layouts/Reference.astro"
title: "NI | Get Started"
heading: "National Instruments Device Driver"
description: "Learn how to acquire data from and control National Instruments hardware using Synnax."
next: "Configure a Device"
nextURL: "/reference/device-drivers/ni/configure-device"
---

import { Divider, Note } from "@synnaxlabs/pluto";

The [National Instruments (NI)](https://www.ni.com/en-us.html) device driver allows
Synnax to directly connect to your NI hardware, including CompactDAQ, CompactRIO, and
PXI systems. This page will walk you through some of the important pre-requisites
necessary to get started with the NI driver.

<Divider.Divider direction="x" />

## Supported Devices

**Synnax supports reading and writing data to all National Instruments devices that are supported by the [NI-DAQmx driver](https://www.ni.com/en-us/support/downloads/drivers/download.ni-daqmx.html).**

Aside from very old DAQ modules, Synnax is generally compatible with every NI device.

<Divider.Divider direction="x" />

## Installation

The NI Driver comes pre-installed with every Synnax Deployment.

### Installing DAQmx and System Configuration Libraries

National Instruments' DAQmx and System Configuration drivers must be installed for Synnax to communicate with your
hardware. Instructions for installing DAQmx can be found on the
[National Instruments website.](https://www.ni.com/en/support/downloads/drivers/download.ni-daq-mx.html#532710)
Instructions for installing System Configuration can be found on the [following page.](https://www.ni.com/en/support/downloads/drivers/download.system-configuration.html)
<Note.Note variant="warning">
If you have a Synnax cluster already running before installing DAQmx, you'll need to
restart the cluster for Synnax to recognize the DAQmx installation.
</Note.Note>

<Divider.Divider direction="x" />

## OS Compatibility

The NI driver is only compatible when running the Synnax Database on a Windows machine.
The driver will not be able to find your devices when running on Linux, macOS, or
within a Docker container (even if that container is running on Windows).

<Divider.Divider direction="x" />

## Next Steps

Now that you've installed DAQmx on your host machine, you're ready to start integrating
your devices. Check out the [Configure a Device](/reference/device-drivers/ni/configure-device)
page to learn how to do so.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
return Astro.rewrite("/reference/device-drivers/labjack/get-started");
---

0 comments on commit 51093b2

Please sign in to comment.