AUBO SDK  0.26.0
Loading...
Searching...
No Matches
arcs::common_interface::SystemInfo Class Reference

#include <system_info.h>

Public Member Functions

 SystemInfo ()
 
virtual ~SystemInfo ()
 
int getControlSoftwareVersionCode ()
 Get the controller software version code
 
std::string getControlSoftwareFullVersion ()
 Get the full controller software version
 
int getInterfaceVersionCode ()
 Get the interface version code
 
std::string getControlSoftwareBuildDate ()
 Get the controller software build date
 
std::string getControlSoftwareVersionHash ()
 Get the controller software git version
 
uint64_t getControlSystemTime ()
 Get the system time (software start time in nanoseconds)
 

Protected Attributes

void * d_
 

Detailed Description

Definition at line 16 of file system_info.h.

Constructor & Destructor Documentation

◆ SystemInfo()

arcs::common_interface::SystemInfo::SystemInfo ( )

◆ ~SystemInfo()

virtual arcs::common_interface::SystemInfo::~SystemInfo ( )
virtual

Member Function Documentation

◆ getControlSoftwareBuildDate()

std::string arcs::common_interface::SystemInfo::getControlSoftwareBuildDate ( )

Get the controller software build date

Returns
Returns the controller software build date
Python prototype
getControlSoftwareBuildDate(self: pyaubo_sdk.SystemInfo) -> str
Lua prototype
getControlSoftwareBuildDate() -> string
C++ example
std::string build_date =
rpc_cli->getSystemInfo()->getControlSoftwareBuildDate();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getControlSoftwareBuildDate","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"2024-3-5 07:03:20"}

◆ getControlSoftwareFullVersion()

std::string arcs::common_interface::SystemInfo::getControlSoftwareFullVersion ( )

Get the full controller software version

Returns
Returns the full controller software version
Python prototype
getControlSoftwareFullVersion(self: pyaubo_sdk.SystemInfo) -> str
Lua prototype
getControlSoftwareFullVersion() -> string
C++ example
std::string control_version =
rpc_cli->getSystemInfo()->getControlSoftwareFullVersion();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getControlSoftwareFullVersion","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"0.31.0-alpha.16+20alc76"}

◆ getControlSoftwareVersionCode()

int arcs::common_interface::SystemInfo::getControlSoftwareVersionCode ( )

Get the controller software version code

Returns
Returns the controller software version code
Python prototype
getControlSoftwareVersionCode(self: pyaubo_sdk.SystemInfo) -> int
Lua prototype
getControlSoftwareVersionCode() -> number
C++ example
int control_version =
rpc_cli->getSystemInfo()->getControlSoftwareVersionCode();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getControlSoftwareVersionCode","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":28003}

◆ getControlSoftwareVersionHash()

std::string arcs::common_interface::SystemInfo::getControlSoftwareVersionHash ( )

Get the controller software git version

Returns
Returns the controller software git version
Python prototype
getControlSoftwareVersionHash(self: pyaubo_sdk.SystemInfo) -> str
Lua prototype
getControlSoftwareVersionHash() -> string
C++ example
std::string git_version =
rpc_cli->getSystemInfo()->getControlSoftwareVersionHash();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getControlSoftwareVersionHash","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":"fa4f64a"}

◆ getControlSystemTime()

uint64_t arcs::common_interface::SystemInfo::getControlSystemTime ( )

Get the system time (software start time in nanoseconds)

Returns
Returns the system time (software start time in nanoseconds)
Python prototype
getControlSystemTime(self: pyaubo_sdk.SystemInfo) -> int
Lua prototype
getControlSystemTime() -> number
C++ example
std::string system_time =
rpc_cli->getSystemInfo()->getControlSystemTime();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getControlSystemTime","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":9287799079682}

◆ getInterfaceVersionCode()

int arcs::common_interface::SystemInfo::getInterfaceVersionCode ( )

Get the interface version code

Returns
Returns the interface version code
Python prototype
getInterfaceVersionCode(self: pyaubo_sdk.SystemInfo) -> int
Lua prototype
getInterfaceVersionCode() -> number
C++ example
int interface_version =
rpc_cli->getSystemInfo()->getInterfaceVersionCode();
JSON-RPC request example
{"jsonrpc":"2.0","method":"SystemInfo.getInterfaceVersionCode","params":[],"id":1}
JSON-RPC response example
{"id":1,"jsonrpc":"2.0","result":22003}

Member Data Documentation

◆ d_

void* arcs::common_interface::SystemInfo::d_
protected

Definition at line 335 of file system_info.h.


The documentation for this class was generated from the following file: