Electronics and Software
Engineering Innovation
BMeasure-lib  0.8.4
BMeasureApi Namespace Reference

Classes

class  AlarmConfig
 
class  AwgConfig
 
class  BMeasure
 
class  BMeasureUnit
 
class  BMeasureUnit1
 
class  BMeasureUnitDevice
 
class  BMeasureUnits
 
class  BMeasureUnitsDataBlock
 
class  BoardConfig
 
class  CalibrateInfo
 
class  ChannelConfig
 
class  CommsNet
 
class  CommsSerial
 
class  CommsUsb
 
class  ConfigItem
 
class  Configuration
 
class  DataBlock
 
class  DataFile
 
class  FileData
 
class  FileInfo
 
class  FilesysInfo
 
class  InfoBlock
 
class  Information
 
class  MeasurementConfig
 
class  NodeInfo
 
class  NodeStatus
 
class  Version
 

Typedefs

typedef BArray< ChannelConfigChannelConfigs
 

Enumerations

enum  ErrorNum { ErrorSystem = 64, ErrorDataOverrun = 65, ErrorToFast = 66 }
 
enum  NodeType { NodeTypeNone = 0, NodeTypeBMeasure1 = 1 }
 
enum  SecureMode { SecureModeOpen, SecureMoteRemote, SecureModeFull }
 
enum  Status {
  StatusNone = 0x00, StatusError = 0x01, StatusWarning = 0x02, StatusRun = 0x04,
  StatusTriggerWait = 0x08, StatusEnd0 = 0x10, StatusEnd1 = 0x20, StatusDataOverrun = 0x40,
  StatusFpgaOverrun = 0x80, StatusAlarm = 0x0100
}
 
enum  Mode {
  ModeIdle = 0, ModeRun = 1, ModeRunProgram = 2, ModeInternal = 3,
  ModeSleep = 4, ModeDemo1 = 5
}
 
enum  BlockTypes { BlockTypeInfo = 0x424E4531, BlockTypeData = 0x424E4532 }
 
enum  ChannelType {
  ChannelTypeNone = 0, ChannelTypeAnalogueIn = 1, ChannelTypeAnalogueOut = 0x81, ChannelTypeDigitalIn = 2,
  ChannelTypeDigitalOut = 0x82
}
 
enum  SampleType {
  SampleTypeNone = 0, SampleTypeBool = 1, SampleTypeInt8 = 2, SampleTypeInt16 = 3,
  SampleTypeInt32 = 4, SampleTypeFloat32 = 5, SampleTypeFloat64 = 6
}
 
enum  SyncMode { SyncModeOff = 0, SyncModeMaster = 1, SyncModeSlave = 2 }
 
enum  MeasureMode { MeasureModeOff = 0, MeasureModeOneShot = 1, MeasureModeRepeat = 2, MeasureModeContinuous = 3 }
 
enum  TriggerMode { TriggerModeOff = 0, TriggerModePositive = 1, TriggerModeNegative = 2 }
 
enum  TriggerConfig { TriggerConfigNone = 0 }
 
enum  DigitalMode {
  DigitalModeInput = 0, DigitalModeOutput = 1, DigitalInOut = 2, DigitalModeSyncMaster = 3,
  DigitalModeSyncSlave = 4
}
 
enum  Waveform {
  WaveformNone, WaveformDc, WaveformSine, WaveformSquare,
  WaveformTriangle, WaveformNoise, WaveformArbitrary
}
 
enum  AwgOutput { AwgOutputNone, AwgOutputAO0, AwgOutputAO1, AwgOutputAO01 }
 
enum  FileType { FileTypeNone, FileTypeFile, FileTypeDir }
 
enum  FilesysDeleteType { FilesysDeleteTypeNone, FilesysDeleteTypeData, FilesysDeleteTypeFormat }
 
enum  LogDataMode { LogDataModeNormal, LogDataModeDeleteOld }
 
enum  DataBlockType { DataBlockTypeFloat32, DataBlockType125i }
 
enum  DataSend { DataSendOff, DataSendOn }
 
enum  CalibrateStage {
  CalibrateStageNone = 0, CalibrateStageClear = 1, CalibrateStageSettle = 2, CalibrateStageAdcOffsets = 3,
  CalibrateStageDacOffsets = 4, CalibrateStageDacScaling0 = 5, CalibrateStageDacScaling1 = 6, CalibrateStageAdcScaling = 7,
  CalibrateStageAttenScaling = 8, CalibrationStageFiveVolts = 9
}
 
enum  MessageSource {
  MessageSourceGeneral = 0, MessageSourceDebug = 1, MessageSourceTest = 2, MessageSourceWifi = 3,
  MessageSourceWifiTest = 4
}
 
enum  NetworkMode { NetworkModeOff = 0, NetworkModeDhcp = 1, NetworkModeManual = 2 }
 
enum  WifiMode { WifiModeOff, WifiModeClient, WifiModeAp }
 
enum  AlarmMode { AlarmModeOff, AlarmModeHigher, AlarmModeLower }
 
enum  AlarmOutput {
  AlarmOutputOff, AlarmOutputDioHigh, AlarmOutputDioLow, AlarmOutputRelayOn,
  AlarmOutputRelayOff
}
 
enum  EventMode { EventModeOff, EventModeAlarm, EventModeSecond }
 
enum  Rs485Mode { Rs485ModeOff, Rs485ModeBoap }
 
enum  TdsDataType {
  TdsTypeVoid, TdsTypeI8, TdsTypeI16, TdsTypeI32,
  TdsTypeI64, TdsTypeU8, TdsTypeU16, TdsTypeU32,
  TdsTypeU64, TdsTypeSingleFloat, TdsTypeDoubleFloat, TdsTypeExtendedFloat,
  TdsTypeSingleFloatWithUnit =0x19, TdsTypeDoubleFloatWithUnit, TdsTypeExtendedFloatWithUnit, TdsTypeString =0x20,
  TdsTypeBoolean =0x21, TdsTypeTimeStamp =0x44, TdsTypeFixedPoint =0x4F, TdsTypeComplexSingleFloat =0x08000c,
  TdsTypeComplexDoubleFloat =0x10000d, TdsTypeDAQmxRawData =0xFFFFFFFF
}
 

Functions

const char * channelTypeString (ChannelType type)
 
const char * sampleTypeString (SampleType type)
 
BFloat32 toFloat (BUInt32 v)
 
static int unitSort (BMeasureUnit1 *&u1, BMeasureUnit1 *&u2)
 
static BUInt32 roundDown512 (BUInt32 size)
 
const BUInt32 TocMetaData (1<< 1)
 
const BUInt32 TocNewObjList (1<< 2)
 
const BUInt32 TocRawData (1<< 3)
 
const BUInt32 TocInterleavedData (1<< 5)
 
const BUInt32 TocBigEndian (1<< 6)
 
const BUInt32 TocDaqRawData (1<< 7)
 
BUInt32 round512 (BUInt32 s)
 

Variables

const BUInt32 apiVersion = 0
 

Typedef Documentation

◆ ChannelConfigs

Enumeration Type Documentation

◆ AlarmMode

Enumerator
AlarmModeOff 
AlarmModeHigher 
AlarmModeLower 

◆ AlarmOutput

Enumerator
AlarmOutputOff 
AlarmOutputDioHigh 
AlarmOutputDioLow 
AlarmOutputRelayOn 
AlarmOutputRelayOff 

◆ AwgOutput

Enumerator
AwgOutputNone 
AwgOutputAO0 
AwgOutputAO1 
AwgOutputAO01 

◆ BlockTypes

Enumerator
BlockTypeInfo 
BlockTypeData 

◆ CalibrateStage

Enumerator
CalibrateStageNone 
CalibrateStageClear 
CalibrateStageSettle 
CalibrateStageAdcOffsets 
CalibrateStageDacOffsets 
CalibrateStageDacScaling0 
CalibrateStageDacScaling1 
CalibrateStageAdcScaling 
CalibrateStageAttenScaling 
CalibrationStageFiveVolts 

◆ ChannelType

Enumerator
ChannelTypeNone 
ChannelTypeAnalogueIn 
ChannelTypeAnalogueOut 
ChannelTypeDigitalIn 
ChannelTypeDigitalOut 

◆ DataBlockType

Enumerator
DataBlockTypeFloat32 
DataBlockType125i 

◆ DataSend

Enumerator
DataSendOff 
DataSendOn 

◆ DigitalMode

Enumerator
DigitalModeInput 
DigitalModeOutput 
DigitalInOut 
DigitalModeSyncMaster 
DigitalModeSyncSlave 

◆ ErrorNum

Enumerator
ErrorSystem 
ErrorDataOverrun 
ErrorToFast 

◆ EventMode

Enumerator
EventModeOff 
EventModeAlarm 
EventModeSecond 

◆ FilesysDeleteType

Enumerator
FilesysDeleteTypeNone 
FilesysDeleteTypeData 
FilesysDeleteTypeFormat 

◆ FileType

Enumerator
FileTypeNone 
FileTypeFile 
FileTypeDir 

◆ LogDataMode

Enumerator
LogDataModeNormal 
LogDataModeDeleteOld 

◆ MeasureMode

Enumerator
MeasureModeOff 
MeasureModeOneShot 
MeasureModeRepeat 
MeasureModeContinuous 

◆ MessageSource

Enumerator
MessageSourceGeneral 
MessageSourceDebug 
MessageSourceTest 
MessageSourceWifi 
MessageSourceWifiTest 

◆ Mode

Enumerator
ModeIdle 
ModeRun 
ModeRunProgram 
ModeInternal 
ModeSleep 
ModeDemo1 

◆ NetworkMode

Enumerator
NetworkModeOff 
NetworkModeDhcp 
NetworkModeManual 

◆ NodeType

Enumerator
NodeTypeNone 
NodeTypeBMeasure1 

◆ Rs485Mode

Enumerator
Rs485ModeOff 
Rs485ModeBoap 

◆ SampleType

Enumerator
SampleTypeNone 
SampleTypeBool 
SampleTypeInt8 
SampleTypeInt16 
SampleTypeInt32 
SampleTypeFloat32 
SampleTypeFloat64 

◆ SecureMode

Enumerator
SecureModeOpen 
SecureMoteRemote 
SecureModeFull 

◆ Status

Enumerator
StatusNone 
StatusError 
StatusWarning 
StatusRun 
StatusTriggerWait 
StatusEnd0 
StatusEnd1 
StatusDataOverrun 
StatusFpgaOverrun 
StatusAlarm 

◆ SyncMode

Enumerator
SyncModeOff 
SyncModeMaster 
SyncModeSlave 

◆ TdsDataType

Enumerator
TdsTypeVoid 
TdsTypeI8 
TdsTypeI16 
TdsTypeI32 
TdsTypeI64 
TdsTypeU8 
TdsTypeU16 
TdsTypeU32 
TdsTypeU64 
TdsTypeSingleFloat 
TdsTypeDoubleFloat 
TdsTypeExtendedFloat 
TdsTypeSingleFloatWithUnit 
TdsTypeDoubleFloatWithUnit 
TdsTypeExtendedFloatWithUnit 
TdsTypeString 
TdsTypeBoolean 
TdsTypeTimeStamp 
TdsTypeFixedPoint 
TdsTypeComplexSingleFloat 
TdsTypeComplexDoubleFloat 
TdsTypeDAQmxRawData 

◆ TriggerConfig

Enumerator
TriggerConfigNone 

◆ TriggerMode

Enumerator
TriggerModeOff 
TriggerModePositive 
TriggerModeNegative 

◆ Waveform

Enumerator
WaveformNone 
WaveformDc 
WaveformSine 
WaveformSquare 
WaveformTriangle 
WaveformNoise 
WaveformArbitrary 

◆ WifiMode

Enumerator
WifiModeOff 
WifiModeClient 
WifiModeAp 

Function Documentation

◆ channelTypeString()

const char * BMeasureApi::channelTypeString ( ChannelType  type)

◆ round512()

BUInt32 BMeasureApi::round512 ( BUInt32  s)

◆ roundDown512()

static BUInt32 BMeasureApi::roundDown512 ( BUInt32  size)
static

◆ sampleTypeString()

const char * BMeasureApi::sampleTypeString ( SampleType  type)

◆ TocBigEndian()

const BUInt32 BMeasureApi::TocBigEndian ( 1<<  6)

◆ TocDaqRawData()

const BUInt32 BMeasureApi::TocDaqRawData ( 1<<  7)

◆ TocInterleavedData()

const BUInt32 BMeasureApi::TocInterleavedData ( 1<<  5)

◆ TocMetaData()

const BUInt32 BMeasureApi::TocMetaData ( 1<<  1)

◆ TocNewObjList()

const BUInt32 BMeasureApi::TocNewObjList ( 1<<  2)

◆ TocRawData()

const BUInt32 BMeasureApi::TocRawData ( 1<<  3)

◆ toFloat()

BFloat32 BMeasureApi::toFloat ( BUInt32  v)
inline

◆ unitSort()

static int BMeasureApi::unitSort ( BMeasureUnit1 *&  u1,
BMeasureUnit1 *&  u2 
)
static

Variable Documentation

◆ apiVersion

const BUInt32 BMeasureApi::apiVersion = 0