nScopeAPI  v0.8
nScopeAPI.h
Go to the documentation of this file.
1 /*******************************************************
2  nScopeAPI - Multi-Platform library for
3  communication with nScope devices.
4 
5  David Meyer
6 
7  10/23/2014
8 
9  Copyright 2014, All Rights Reserved.
10 
11 ********************************************************/
12 
18 #ifndef NSCOPEAPI_H__
19 #define NSCOPEAPI_H__
20 
21 
22 #include "nScopeAPI_defs.h"
23 #include "nScopeAPI_requests.h"
24 #include "nScopeAPI_analogInputs.h"
25 #include "nScopeAPI_sampleTiming.h"
26 #include "nScopeAPI_trigger.h"
29 #include "stdbool.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 
36 
50  NSCOPE_API ErrorType nScope_open(bool powerOn, ScopeHandle* nScope_p);
51 
60 
73 
87 
98  NSCOPE_API ErrorType nScope_get_power_usage(ScopeHandle nScope, double *powerUsage);
99 
110 
117 
124 
133 
141  NSCOPE_API ErrorType nScope_check_API_version(double* apiVersion);
142 
150  NSCOPE_API ErrorType nScope_check_FW_version(double* fwVersion);
151 
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 
165 #endif
#define NSCOPE_API
Definition: nScopeAPI_defs.h:29
NSCOPE_API ErrorType nScope_initialize(ScopeHandle nScope)
Initialize an nScope with the default configuration.
NSCOPE_API ErrorType nScope_clean(ScopeHandle *nScope_p)
Clean up an nScope device.
NSCOPE_API ErrorType nScope_load_firmware()
load the nScope with current firmware
ErrorType
Definition: nScopeAPI_defs.h:42
NSCOPE_API ErrorType nScope_find_firmware_loader()
find the firmware loader
NSCOPE_API ErrorType nScope_write_to_loader()
write the firmware to the loader
contains function headers for controlling the nScope trigger function
header file for common definitions
PowerState
Definition: nScopeAPI_defs.h:86
contains function headers for controlling the nScope pulse outputs
NSCOPE_API ErrorType nScope_check_API_build(int *buildNo)
check the build number of this API
contains function headers for controlling the nScope analog outputs
NSCOPE_API ErrorType nScope_check_FW_version(double *fwVersion)
check the version of the connected firmware
NSCOPE_API ErrorType nScope_close(ScopeHandle *nScope_p)
Close and clean a connected nScope device.
struct scopeDev_ * ScopeHandle
Definition: nScopeAPI_defs.h:32
NSCOPE_API ErrorType nScope_check_API_version(double *apiVersion)
check the version of this API
contains function headers for controlling the nScope analog inputs
contains function headers for controlling the nScope sample timing
NSCOPE_API ErrorType nScope_get_power_state(ScopeHandle nScope, PowerState *powerState)
Read the PowerState of the nScope.
NSCOPE_API ErrorType nScope_open(bool powerOn, ScopeHandle *nScope_p)
Open a connected nScope device and initialize it.
NSCOPE_API ErrorType nScope_get_power_usage(ScopeHandle nScope, double *powerUsage)
Read how much power is being used by nScope.
contains function headers for making requests to nScope