# Bronkhorst gas flowmeter / flow controller

This repository contains the driver code and Midas frontend for the Bronkhorst
gas flowmeter / flow controller.

## Requirements

Requires a Midas installation with the environment variable `MIDASSYS` pointing
to the built Midas artifacts and headers.

## Build

Clone this repository, enter the cloned directory, and then build via CMake.

```bash
cmake -S "$(pwd)" -B <directory-to-build-in> -DBUILD_FRONTEND=ON
cmake --build <directory-to-build-in> --clean-first -- -j8
```

## Run

```bash
/build/driver/bronkhorst_flowmeter_fe -e flame
```

## Including in Custom Frontend

To include this driver in a custom frontend, you should ensure the environment
variable `MIDASSYS` points to your system install and include a snippet in your
`CMakeLists.txt` similar to the following:

```CMake
# If the path to the bronkhorst_flowmeter repository is outside of the frontend
# repository, you also need to provide a location for the bronkhorst_flowmeter
# artifacts as a second argument to `add_subdirectory`
# e.g. `./device/bronkhorst_flowmeter`
add_subdirectory(
    <path-to-bronkhorst_flowmeter-repository>
)

add_executable(
  <frontend-name>
  <frontend-code-path-1>
  <frontend-code-path-2>
  :
)

set_property(
  TARGET
    <frontend-name>
  PROPERTY
    CXX_STANDARD 11
)

target_include_directories(
  <frontend-name>
  PRIVATE
    $ENV{MIDASSYS}/drivers
    $ENV{MIDASSYS}/include
)

target_link_libraries(
  <frontend-name>
  bronkhorst_flowmeter
  <additional-library-1>
  <additional-library-2>
  :
)
```