Add ReadAnalogWaveforms to NiDAQmxService

CMakeLists.txt

@@ -18,6 +18,12 @@ if(MSVC)
   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /std:c17") # Needed for boringssl
 endif()
 
+# GCC-specific flags
+if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-var-tracking-assignments")
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fno-var-tracking-assignments")
+endif()
+
 #----------------------------------------------------------------------
 # Use C++17 (needed for shared_mutex support on Linux)
 #----------------------------------------------------------------------
@@ -289,6 +295,8 @@ get_filename_component(deviceid_restricted_proto "source/protobuf_restricted/dev
 get_filename_component(debugsessionproperties_restricted_proto "source/protobuf_restricted/debugsessionproperties_restricted.proto" ABSOLUTE)
 get_filename_component(calibrationoperations_restricted_proto "source/protobuf_restricted/calibrationoperations_restricted.proto" ABSOLUTE)
 get_filename_component(data_moniker_proto "imports/protobuf/data_moniker.proto" ABSOLUTE)
+get_filename_component(precision_timestamp_proto "third_party/ni-apis/ni/protobuf/types/precision_timestamp.proto" ABSOLUTE)
+get_filename_component(waveform_proto "third_party/ni-apis/ni/protobuf/types/waveform.proto" ABSOLUTE)
 get_filename_component(session_proto_path "${session_proto}" PATH)
 
 #----------------------------------------------------------------------
@@ -303,8 +311,9 @@ function(GenerateGrpcSources)
   set(proto_file "${GENERATE_ARGS_PROTO}")
   if(USE_SUBMODULE_LIBS)
     set(protobuf_includes_arg 
-      -I ${CMAKE_SOURCE_DIR}/third_party/grpc/third_party/protobuf/src/ 
-      -I ${CMAKE_SOURCE_DIR}/third_party/ni-apis/ni/grpcdevice/v1/) # for session.proto
+      -I ${CMAKE_SOURCE_DIR}/third_party/grpc/third_party/protobuf/src/
+      -I ${CMAKE_SOURCE_DIR}/third_party/ni-apis/ni/grpcdevice/v1/ # for session.proto
+      -I ${CMAKE_SOURCE_DIR}/third_party/ni-apis/)
   endif()
   get_filename_component(proto_name "${proto_file}" NAME)
   get_filename_component(proto_path "${proto_file}" PATH)
@@ -346,6 +355,34 @@ function(GenerateGrpcSources)
   endif()
 endfunction()
 
+#----------------------------------------------------------------------
+# Generate sources from ni-apis proto files
+# Usage: GenerateNiApisProtoSources(PROTO_PATH <relative_path> OUTPUT_SRCS <var> OUTPUT_HDRS <var> [DEPENDS <dependency>...])
+#----------------------------------------------------------------------
+function(GenerateNiApisProtoSources)
+  set(oneValueArgs PROTO_PATH OUTPUT_SRCS OUTPUT_HDRS)
+  set(multiValueArgs DEPENDS)
+  cmake_parse_arguments(GEN_ARGS "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+  set(proto_srcs "${proto_srcs_dir}/${GEN_ARGS_PROTO_PATH}.pb.cc")
+  set(proto_hdrs "${proto_srcs_dir}/${GEN_ARGS_PROTO_PATH}.pb.h")
+
+  add_custom_command(
+    OUTPUT "${proto_srcs}" "${proto_hdrs}"
+    COMMAND ${_PROTOBUF_PROTOC}
+    ARGS --cpp_out ${proto_srcs_dir}
+      -I ${CMAKE_SOURCE_DIR}/third_party/ni-apis/
+      -I ${CMAKE_SOURCE_DIR}/third_party/grpc/third_party/protobuf/src/
+      ${GEN_ARGS_PROTO_PATH}.proto
+    DEPENDS "${CMAKE_SOURCE_DIR}/third_party/ni-apis/${GEN_ARGS_PROTO_PATH}.proto" ${GEN_ARGS_DEPENDS}
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/third_party/ni-apis/
+    VERBATIM
+  )
+
+  set(${GEN_ARGS_OUTPUT_SRCS} "${proto_srcs}" PARENT_SCOPE)
+  set(${GEN_ARGS_OUTPUT_HDRS} "${proto_hdrs}" PARENT_SCOPE)
+endfunction()
+
 set(session_proto_srcs "${proto_srcs_dir}/session.pb.cc")
 set(session_proto_hdrs "${proto_srcs_dir}/session.pb.h")
 set(session_grpc_srcs "${proto_srcs_dir}/session.grpc.pb.cc")
@@ -372,6 +409,10 @@ set(data_moniker_proto_srcs "${proto_srcs_dir}/data_moniker.pb.cc")
 set(data_moniker_proto_hdrs "${proto_srcs_dir}/data_moniker.pb.h")
 set(data_moniker_grpc_srcs "${proto_srcs_dir}/data_moniker.grpc.pb.cc")
 set(data_moniker_grpc_hdrs "${proto_srcs_dir}/data_moniker.grpc.pb.h")
+set(precision_timestamp_proto_srcs "${proto_srcs_dir}/ni/protobuf/types/precision_timestamp.pb.cc")
+set(precision_timestamp_proto_hdrs "${proto_srcs_dir}/ni/protobuf/types/precision_timestamp.pb.h")
+set(waveform_proto_srcs "${proto_srcs_dir}/ni/protobuf/types/waveform.pb.cc")
+set(waveform_proto_hdrs "${proto_srcs_dir}/ni/protobuf/types/waveform.pb.h")
 
 GenerateGrpcSources(
   PROTO
@@ -441,6 +482,19 @@ GenerateGrpcSources(
     "${data_moniker_grpc_hdrs}"
 )
 
+GenerateNiApisProtoSources(
+  PROTO_PATH "ni/protobuf/types/precision_timestamp"
+  OUTPUT_SRCS precision_timestamp_proto_srcs
+  OUTPUT_HDRS precision_timestamp_proto_hdrs
+)
+
+GenerateNiApisProtoSources(
+  PROTO_PATH "ni/protobuf/types/waveform"
+  OUTPUT_SRCS waveform_proto_srcs
+  OUTPUT_HDRS waveform_proto_hdrs
+  DEPENDS "${precision_timestamp_proto_hdrs}"
+)
+
 set(nidriver_service_library_hdrs
   ${nidriver_service_library_hdrs}
   "${session_proto_hdrs}"
@@ -454,6 +508,8 @@ set(nidriver_service_library_hdrs
   "${debugsessionproperties_restricted_grpc_hdrs}"
   "${calibrationoperations_restricted_proto_hdrs}"
   "${calibrationoperations_restricted_grpc_hdrs}"
+  "${precision_timestamp_proto_hdrs}"
+  "${waveform_proto_hdrs}"
 )
 
 foreach(api ${nidrivers})
@@ -514,6 +570,8 @@ add_executable(ni_grpc_device_server
    ${calibrationoperations_restricted_grpc_srcs}
    ${data_moniker_proto_srcs}
    ${data_moniker_grpc_srcs}
+   ${precision_timestamp_proto_srcs}
+   ${waveform_proto_srcs}
    ${nidriver_service_srcs})
 
 # Enable warnings only on source that we own, not generated code or dependencies
@@ -655,6 +713,8 @@ add_executable(IntegrationTestsRunner
     ${calibrationoperations_restricted_grpc_srcs}
     ${data_moniker_proto_srcs}
     ${data_moniker_grpc_srcs}
+    ${precision_timestamp_proto_srcs}
+    ${waveform_proto_srcs}
     ${nidriver_service_srcs}
     "${proto_srcs_dir}/nifake.pb.cc"
     "${proto_srcs_dir}/nifake.grpc.pb.cc"
@@ -711,6 +771,7 @@ add_executable(UnitTestsRunner
     "source/tests/unit/ni_fake_non_ivi_service_tests.cpp"
     "source/tests/unit/ni_fake_service_tests.cpp"
     "source/tests/unit/nimxlc_terminal_adaptor_converters_tests.cpp"
+    "source/tests/unit/precision_timestamp_converter_tests.cpp"
     "source/tests/unit/shared_library_tests.cpp"
     "source/tests/unit/syscfg_library_tests.cpp"
     "source/tests/unit/syscfg_resource_accessor_tests.cpp"
@@ -742,6 +803,8 @@ add_executable(UnitTestsRunner
     ${calibrationoperations_restricted_grpc_srcs}
     ${data_moniker_proto_srcs}
     ${data_moniker_grpc_srcs}
+    ${precision_timestamp_proto_srcs}
+    ${waveform_proto_srcs}
     "${proto_srcs_dir}/nifake.pb.cc"
     "${proto_srcs_dir}/nifake.grpc.pb.cc"
     "${proto_srcs_dir}/nifake_extension.pb.cc"
@@ -879,6 +942,8 @@ set(system_test_runner_sources
   ${calibrationoperations_restricted_grpc_srcs}
   ${data_moniker_proto_srcs}
   ${data_moniker_grpc_srcs}
+  ${precision_timestamp_proto_srcs}
+  ${waveform_proto_srcs}
   ${nidriver_service_srcs}
   ${nidriver_client_srcs}
 )

CONTRIBUTING.md

@@ -68,6 +68,18 @@ Build a release build for use in a production environment:
 > cmake --build . --config Release
 ```
 
+### Build with Ninja
+
+Build faster by using Ninja:
+
+```
+> "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
+> mkdir build
+> cd build
+> cmake .. -G "Ninja Multi-Config"
+> cmake --build .
+```
+
 ## Building on Linux
 
 ### Prerequisites

generated/nidaqmx/nidaqmx.proto

@@ -16,6 +16,7 @@ package nidaqmx_grpc;
 
 import "session.proto";
 import "data_moniker.proto";
+import "ni/protobuf/types/waveform.proto";
 import "google/protobuf/timestamp.proto";
 
 service NiDAQmx {
@@ -465,6 +466,7 @@ service NiDAQmx {
   rpc BeginWriteRaw(BeginWriteRawRequest) returns (BeginWriteRawResponse);
   rpc WriteToTEDSFromArray(WriteToTEDSFromArrayRequest) returns (WriteToTEDSFromArrayResponse);
   rpc WriteToTEDSFromFile(WriteToTEDSFromFileRequest) returns (WriteToTEDSFromFileResponse);
+  rpc ReadAnalogWaveforms(ReadAnalogWaveformsRequest) returns (ReadAnalogWaveformsResponse);
 }
 
 enum BufferUInt32Attribute {
@@ -3558,6 +3560,12 @@ enum WriteBasicTEDSOptions {
   WRITE_BASIC_TEDS_OPTIONS_DO_NOT_WRITE = 12540;
 }
 
+enum WaveformAttributeMode {
+  WAVEFORM_ATTRIBUTE_MODE_NONE = 0;
+  WAVEFORM_ATTRIBUTE_MODE_TIMING = 1;
+  WAVEFORM_ATTRIBUTE_MODE_EXTENDED_PROPERTIES = 2;
+}
+
 enum ChannelInt32AttributeValues {
   option allow_alias = true;
   CHANNEL_INT32_UNSPECIFIED = 0;
@@ -11511,3 +11519,19 @@ message WriteToTEDSFromFileResponse {
   int32 status = 1;
 }
 
+message ReadAnalogWaveformsRequest {
+  nidevice_grpc.Session task = 1;
+  int32 num_samps_per_chan = 2;
+  double timeout = 3;
+  oneof waveform_attribute_mode_enum {
+    WaveformAttributeMode waveform_attribute_mode = 4;
+    int32 waveform_attribute_mode_raw = 5;
+  }
+}
+
+message ReadAnalogWaveformsResponse {
+  int32 status = 1;
+  repeated ni.protobuf.types.DoubleAnalogWaveform waveforms = 2;
+  int32 samps_per_chan_read = 3;
+}
+

generated/nidaqmx/nidaqmx_client.cpp

@@ -12414,5 +12414,32 @@ write_to_teds_from_file(const StubPtr& stub, const std::string& physical_channel
   return response;
 }
 
+ReadAnalogWaveformsResponse
+read_analog_waveforms(const StubPtr& stub, const nidevice_grpc::Session& task, const pb::int32& num_samps_per_chan, const double& timeout, const simple_variant<WaveformAttributeMode, pb::int32>& waveform_attribute_mode)
+{
+  ::grpc::ClientContext context;
+
+  auto request = ReadAnalogWaveformsRequest{};
+  request.mutable_task()->CopyFrom(task);
+  request.set_num_samps_per_chan(num_samps_per_chan);
+  request.set_timeout(timeout);
+  const auto waveform_attribute_mode_ptr = waveform_attribute_mode.get_if<WaveformAttributeMode>();
+  const auto waveform_attribute_mode_raw_ptr = waveform_attribute_mode.get_if<pb::int32>();
+  if (waveform_attribute_mode_ptr) {
+    request.set_waveform_attribute_mode(*waveform_attribute_mode_ptr);
+  }
+  else if (waveform_attribute_mode_raw_ptr) {
+    request.set_waveform_attribute_mode_raw(*waveform_attribute_mode_raw_ptr);
+  }
+
+  auto response = ReadAnalogWaveformsResponse{};
+
+  raise_if_error(
+      stub->ReadAnalogWaveforms(&context, request, &response),
+      context);
+
+  return response;
+}
+
 
 } // namespace nidaqmx_grpc::experimental::client

generated/nidaqmx/nidaqmx_client.h

@@ -468,6 +468,7 @@ WriteRawResponse write_raw(const StubPtr& stub, const nidevice_grpc::Session& ta
 BeginWriteRawResponse begin_write_raw(const StubPtr& stub, const nidevice_grpc::Session& task, const pb::int32& num_samps, const bool& auto_start, const double& timeout);
 WriteToTEDSFromArrayResponse write_to_teds_from_array(const StubPtr& stub, const std::string& physical_channel, const std::string& bit_stream, const simple_variant<WriteBasicTEDSOptions, pb::int32>& basic_teds_options);
 WriteToTEDSFromFileResponse write_to_teds_from_file(const StubPtr& stub, const std::string& physical_channel, const std::string& file_path, const simple_variant<WriteBasicTEDSOptions, pb::int32>& basic_teds_options);
+ReadAnalogWaveformsResponse read_analog_waveforms(const StubPtr& stub, const nidevice_grpc::Session& task, const pb::int32& num_samps_per_chan, const double& timeout, const simple_variant<WaveformAttributeMode, pb::int32>& waveform_attribute_mode);
 
 } // namespace nidaqmx_grpc::experimental::client
 

generated/nidaqmx/nidaqmx_library.cpp

@@ -268,6 +268,11 @@ NiDAQmxLibrary::NiDAQmxLibrary(std::shared_ptr<nidevice_grpc::SharedLibraryInter
   function_pointers_.GetWriteAttributeString = reinterpret_cast<GetWriteAttributeStringPtr>(shared_library_->get_function_pointer("DAQmxGetWriteAttribute"));
   function_pointers_.GetWriteAttributeUInt32 = reinterpret_cast<GetWriteAttributeUInt32Ptr>(shared_library_->get_function_pointer("DAQmxGetWriteAttribute"));
   function_pointers_.GetWriteAttributeUInt64 = reinterpret_cast<GetWriteAttributeUInt64Ptr>(shared_library_->get_function_pointer("DAQmxGetWriteAttribute"));
+  function_pointers_.InternalGetLastCreatedChan = reinterpret_cast<InternalGetLastCreatedChanPtr>(shared_library_->get_function_pointer("DAQmxInternalGetLastCreatedChan"));
+  function_pointers_.InternalReadAnalogWaveformPerChan = reinterpret_cast<InternalReadAnalogWaveformPerChanPtr>(shared_library_->get_function_pointer("DAQmxInternalReadAnalogWaveformPerChan"));
+  function_pointers_.InternalReadDigitalWaveform = reinterpret_cast<InternalReadDigitalWaveformPtr>(shared_library_->get_function_pointer("DAQmxInternalReadDigitalWaveform"));
+  function_pointers_.InternalWriteAnalogWaveformPerChan = reinterpret_cast<InternalWriteAnalogWaveformPerChanPtr>(shared_library_->get_function_pointer("DAQmxInternalWriteAnalogWaveformPerChan"));
+  function_pointers_.InternalWriteDigitalWaveform = reinterpret_cast<InternalWriteDigitalWaveformPtr>(shared_library_->get_function_pointer("DAQmxInternalWriteDigitalWaveform"));
   function_pointers_.IsTaskDone = reinterpret_cast<IsTaskDonePtr>(shared_library_->get_function_pointer("DAQmxIsTaskDone"));
   function_pointers_.LoadTask = reinterpret_cast<LoadTaskPtr>(shared_library_->get_function_pointer("DAQmxLoadTask"));
   function_pointers_.PerformBridgeOffsetNullingCalEx = reinterpret_cast<PerformBridgeOffsetNullingCalExPtr>(shared_library_->get_function_pointer("DAQmxPerformBridgeOffsetNullingCalEx"));
@@ -2368,6 +2373,46 @@ int32 NiDAQmxLibrary::GetWriteAttributeUInt64(TaskHandle task, int32 attribute,
   return function_pointers_.GetWriteAttributeUInt64(task, attribute, value);
 }
 
+int32 NiDAQmxLibrary::InternalGetLastCreatedChan(char value[], uInt32 size)
+{
+  if (!function_pointers_.InternalGetLastCreatedChan) {
+    throw nidevice_grpc::LibraryLoadException("Could not find DAQmxInternalGetLastCreatedChan.");
+  }
+  return function_pointers_.InternalGetLastCreatedChan(value, size);
+}
+
+int32 NiDAQmxLibrary::InternalReadAnalogWaveformPerChan(TaskHandle task, int32 numSampsPerChan, float64 timeout, int64 t0Array[], int64 dtArray[], uInt32 timingArraySize, DAQmxSetWfmAttrCallbackPtr setWfmAttrCallback, void* setWfmAttrCallbackData, float64 * readArrayPtrs[], uInt32 readArrayCount, uInt32 arraySizeInSampsPerChan, int32* sampsPerChanRead, bool32* reserved)
+{
+  if (!function_pointers_.InternalReadAnalogWaveformPerChan) {
+    throw nidevice_grpc::LibraryLoadException("Could not find DAQmxInternalReadAnalogWaveformPerChan.");
+  }
+  return function_pointers_.InternalReadAnalogWaveformPerChan(task, numSampsPerChan, timeout, t0Array, dtArray, timingArraySize, setWfmAttrCallback, setWfmAttrCallbackData, readArrayPtrs, readArrayCount, arraySizeInSampsPerChan, sampsPerChanRead, reserved);
+}
+
+int32 NiDAQmxLibrary::InternalReadDigitalWaveform(TaskHandle task, int32 numSampsPerChan, float64 timeout, bool32 fillMode, int64 t0Array[], int64 dtArray[], uInt32 timingArraySize, DAQmxSetWfmAttrCallbackPtr setWfmAttrCallback, void* setWfmAttrCallbackData, uInt8 readArray[], uInt32 arraySizeInBytes, int32* sampsPerChanRead, int32* numBytesPerSamp, uInt32 bytesPerChanArray[], uInt32 bytesPerChanArraySize, bool32* reserved)
+{
+  if (!function_pointers_.InternalReadDigitalWaveform) {
+    throw nidevice_grpc::LibraryLoadException("Could not find DAQmxInternalReadDigitalWaveform.");
+  }
+  return function_pointers_.InternalReadDigitalWaveform(task, numSampsPerChan, timeout, fillMode, t0Array, dtArray, timingArraySize, setWfmAttrCallback, setWfmAttrCallbackData, readArray, arraySizeInBytes, sampsPerChanRead, numBytesPerSamp, bytesPerChanArray, bytesPerChanArraySize, reserved);
+}
+
+int32 NiDAQmxLibrary::InternalWriteAnalogWaveformPerChan(TaskHandle task, int32 numSampsPerChan, bool32 autoStart, float64 timeout, const float64 * const writeArrayPtrs[], uInt32 writeArrayCount, int32* sampsPerChanWritten, bool32* reserved)
+{
+  if (!function_pointers_.InternalWriteAnalogWaveformPerChan) {
+    throw nidevice_grpc::LibraryLoadException("Could not find DAQmxInternalWriteAnalogWaveformPerChan.");
+  }
+  return function_pointers_.InternalWriteAnalogWaveformPerChan(task, numSampsPerChan, autoStart, timeout, writeArrayPtrs, writeArrayCount, sampsPerChanWritten, reserved);
+}
+
+int32 NiDAQmxLibrary::InternalWriteDigitalWaveform(TaskHandle task, int32 numSampsPerChan, bool32 autoStart, float64 timeout, bool32 dataLayout, const uInt8 writeArray[], const uInt32 bytesPerChanArray[], uInt32 bytesPerChanArraySize, int32* sampsPerChanWritten, bool32* reserved)
+{
+  if (!function_pointers_.InternalWriteDigitalWaveform) {
+    throw nidevice_grpc::LibraryLoadException("Could not find DAQmxInternalWriteDigitalWaveform.");
+  }
+  return function_pointers_.InternalWriteDigitalWaveform(task, numSampsPerChan, autoStart, timeout, dataLayout, writeArray, bytesPerChanArray, bytesPerChanArraySize, sampsPerChanWritten, reserved);
+}
+
 int32 NiDAQmxLibrary::IsTaskDone(TaskHandle task, bool32* isTaskDone)
 {
   if (!function_pointers_.IsTaskDone) {