|
virtual int | _invokeValueCallback (string value) |
|
Y_AUTOSTART_enum | autoStart (void) |
|
Y_BEACONDRIVEN_enum | beaconDriven (void) |
|
Y_CLEARHISTORY_enum | clearHistory (void) |
|
int | currentRunIndex (void) |
|
int | dataStreams (vector< YDataStream * > &v) |
|
virtual int | forgetAllDataStreams (void) |
|
Y_AUTOSTART_enum | get_autoStart (void) |
|
Y_BEACONDRIVEN_enum | get_beaconDriven (void) |
|
Y_CLEARHISTORY_enum | get_clearHistory (void) |
|
int | get_currentRunIndex (void) |
|
virtual vector< YDataSet > | get_dataSets (void) |
|
int | get_dataStreams (vector< YDataStream * > &v) |
|
Y_RECORDING_enum | get_recording (void) |
|
s64 | get_timeUTC (void) |
|
YDataLogger * | next (void) |
|
YDataLogger * | nextDataLogger (void) |
|
virtual vector< YDataSet > | parse_dataSets (string json) |
|
Y_RECORDING_enum | recording (void) |
|
virtual int | registerValueCallback (YDataLoggerValueCallback callback) |
|
int | set_autoStart (Y_AUTOSTART_enum newval) |
|
int | set_beaconDriven (Y_BEACONDRIVEN_enum newval) |
|
int | set_clearHistory (Y_CLEARHISTORY_enum newval) |
|
int | set_recording (Y_RECORDING_enum newval) |
|
int | set_timeUTC (s64 newval) |
|
int | setAutoStart (Y_AUTOSTART_enum newval) |
|
int | setBeaconDriven (Y_BEACONDRIVEN_enum newval) |
|
int | setClearHistory (Y_CLEARHISTORY_enum newval) |
|
int | setRecording (Y_RECORDING_enum newval) |
|
int | setTimeUTC (s64 newval) |
|
s64 | timeUTC (void) |
|
| ~YDataLogger () |
|
void | _clearDataStreamCache () |
|
string | _decode_json_string (const string &json) |
|
string | _download (const string &url) |
|
YDataStream * | _findDataStream (YDataSet &dataset, const string &def) |
|
string | _get_json_path (const string &json, const string &path) |
|
vector< string > | _json_get_array (const string &json) |
|
string | _json_get_key (const string &json, const string &data) |
|
string | _json_get_string (const string &json) |
|
int | _parseEx (yJsonStateMachine &j) |
|
virtual int | _parserHelper (void) |
|
string | _parseString (yJsonStateMachine &j) |
|
string | _request (const string &request) |
|
string | _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context) |
|
void | _throw (YRETCODE errType, string errMsg) |
|
YRETCODE | _upload (const string &path, const string &content) |
|
YRETCODE | _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context) |
|
string | advertisedValue (void) |
|
void | clearCache () |
|
string | describe (void) |
|
string | errMessage (void) |
|
string | errorMessage (void) |
|
YRETCODE | errorType (void) |
|
YRETCODE | errType (void) |
|
YFUN_DESCR | functionDescriptor (void) |
|
string | get_advertisedValue (void) |
|
string | get_errorMessage (void) |
|
YRETCODE | get_errorType (void) |
|
virtual string | get_friendlyName (void) |
|
YFUN_DESCR | get_functionDescriptor (void) |
|
string | get_functionId (void) |
|
string | get_hardwareId (void) |
|
string | get_hubSerial () |
|
string | get_logicalName (void) |
|
YModule * | get_module (void) |
|
void * | get_userData (void) |
|
bool | isOnline (void) |
|
YRETCODE | load (int msValidity) |
|
virtual string | loadAttribute (string attrName) |
|
string | logicalName (void) |
|
YModule * | module (void) |
|
virtual int | muteValueCallbacks (void) |
|
YFunction * | next (void) |
|
YFunction * | nextFunction (void) |
|
virtual int | registerValueCallback (YFunctionValueCallback callback) |
|
int | set_advertisedValue (const string &newval) |
|
int | set_logicalName (const string &newval) |
|
void | set_userData (void *data) |
|
int | setAdvertisedValue (const string &newval) |
|
int | setLogicalName (const string &newval) |
|
void | setUserData (void *data) |
|
virtual int | unmuteValueCallbacks (void) |
|
void * | userData (void) |
|
virtual | ~YFunction () |
|
|
YRETCODE | _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg) |
|
string | _escapeAttr (const string &changeval) |
|
YRETCODE | _getDescriptor (YFUN_DESCR &fundescr, string &errMsg) |
|
YRETCODE | _getDevice (YDevice *&dev, string &errMsg) |
|
YRETCODE | _load_unsafe (int msValidity) |
|
YRETCODE | _nextFunction (string &hwId) |
|
int | _parse (YJSONObject *j) |
|
YRETCODE | _setAttr (string attrname, string newvalue) |
|
| YFunction (const string &func) |
|
static void | _AddToCache (const string &classname, const string &func, YFunction *obj) |
|
static YFunction * | _FindFromCache (const string &classname, const string &func) |
|
static void | _UpdateTimedReportCallbackList (YFunction *func, bool add) |
|
static void | _UpdateValueCallbackList (YFunction *func, bool add) |
|
string | _advertisedValue |
|
u64 | _cacheExpiration |
|
string | _className |
|
std::map< string, YDataStream * > | _dataStreams |
|
string | _func |
|
YFUN_DESCR | _fundescr |
|
string | _funId |
|
string | _hwId |
|
string | _lastErrorMsg |
|
YRETCODE | _lastErrorType |
|
string | _logicalName |
|
string | _serial |
|
yCRITICAL_SECTION | _this_cs |
|
void * | _userData |
|
YFunctionValueCallback | _valueCallbackFunction |
|
static std::map< string, YFunction * > | _cache |
|
YDataLogger Class: DataLogger function interface
Yoctopuce sensors include a non-volatile memory capable of storing ongoing measured data automatically, without requiring a permanent connection to a computer. The DataLogger function controls the global parameters of the internal data logger.
Definition at line 3633 of file yocto_api.h.
YDataLogger * YDataLogger::FindDataLogger |
( |
string |
func | ) |
|
|
static |
Retrieves a data logger for a given identifier. The identifier can be specified using several formats:
-
FunctionLogicalName
-
ModuleSerialNumber.FunctionIdentifier
-
ModuleSerialNumber.FunctionLogicalName
-
ModuleLogicalName.FunctionIdentifier
-
ModuleLogicalName.FunctionLogicalName
This function does not require that the data logger is online at the time it is invoked. The returned object is nevertheless valid. Use the method YDataLogger.isOnline() to test if the data logger is indeed online at a given time. In case of ambiguity when looking for a data logger by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func | : a string that uniquely characterizes the data logger |
- Returns
- a YDataLogger object allowing you to drive the data logger.
Definition at line 9047 of file yocto_api.cpp.
vector< YDataSet > YDataLogger::get_dataSets |
( |
void |
| ) |
|
|
virtual |
Returns a list of YDataSet objects that can be used to retrieve all measures stored by the data logger.
This function only works if the device uses a recent firmware, as YDataSet objects are not supported by firmwares older than version 13000.
- Returns
- a list of YDataSet object.
On failure, throws an exception or returns an empty list.
Definition at line 9133 of file yocto_api.cpp.
int YDataLogger::get_dataStreams |
( |
vector< YDataStream * > & |
v | ) |
|
Builds a list of all data streams hold by the data logger (legacy method). The caller must pass by reference an empty array to hold YDataStream objects, and the function fills it with objects describing available data sequences.
This is the old way to retrieve data from the DataLogger. For new applications, you should rather use get_dataSets() method, or call directly get_recordedData() on the sensor object.
- Parameters
-
- Returns
- YAPI_SUCCESS if the call succeeds.
On failure, throws an exception or returns a negative error code.
Definition at line 8624 of file yocto_api.cpp.
Retrieves a data logger for a given identifier. The identifier can be specified using several formats:
-
FunctionLogicalName
-
ModuleSerialNumber.FunctionIdentifier
-
ModuleSerialNumber.FunctionLogicalName
-
ModuleLogicalName.FunctionIdentifier
-
ModuleLogicalName.FunctionLogicalName
This function does not require that the data logger is online at the time it is invoked. The returned object is nevertheless valid. Use the method YDataLogger.isOnline() to test if the data logger is indeed online at a given time. In case of ambiguity when looking for a data logger by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func | : a string that uniquely characterizes the data logger |
- Returns
- a YDataLogger object allowing you to drive the data logger.
Definition at line 3979 of file yocto_api.h.