Wifi-DAQ-E3-AO

Device pinout

API function description

class pywpc.WifiDAQE3AO

Analog output: 8ch simultaneous and 16-bit single-ended
Output range: +/-10V
Built-in 9DoF IMU with posture estimation
Web-based configurator
802.11 b/g/n Wi-Fi
2.4GHz to 2.5GHz

AHRS_close(port, timeout=3)

Close AHRS module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AHRS_close_async(port)

Close AHRS module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AHRS_getAcceleration(port, timeout=3)

Get AHRS’s 3 axis acceleration.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

accelerationlist: The list of 3 axis acceleration.

async AHRS_getAcceleration_async(port)

Get AHRS’s 3 axis acceleration with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

accelerationlist: The list of 3 axis acceleration.

AHRS_getAngularVelocity(port, timeout=3)

Get AHRS’s 3 axis angular velocity.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

angular velocitylist: The list of 3 axis angular velocity.

async AHRS_getAngularVelocity_async(port)

Get AHRS’s 3 axis angular velocity with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

angular velocitylist: The list of 3 axis angular velocity.

AHRS_getEstimate(port, mode, timeout=3)

Get AHRS’s estimation with mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
mode: 0: 3-axis of orientation. 1: 3-axis of acceleration. 2: 3-axis of angular velocity. 3: 3-axis of orientation and acceleration. 4: 3-axis of orientation and angular velocity. 5: 3-axis of angular velocity and acceleration. 6: 3-axis of orientation and angular velocity and acceleration.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

The list of 3 axis’s data.

async AHRS_getEstimate_async(port, mode)

Get AHRS’s estimation with mode with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
mode: 0: 3-axis of orientation. 1: 3-axis of acceleration. 2: 3-axis of angular velocity. 3: 3-axis of orientation and acceleration. 4: 3-axis of orientation and angular velocity. 5: 3-axis of angular velocity and acceleration. 6: 3-axis of orientation and angular velocity and acceleration.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AHRS_getOrientation(port, timeout=3)

Get AHRS’s 3 axis orientation.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

orientationlist: The list of 3 axis orientation.

async AHRS_getOrientation_async(port)

Get AHRS’s 3 axis orientation with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

orientationlist: The list of 3 axis orientation.

AHRS_open(port, timeout=3)

Open AHRS module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AHRS_open_async(port)

Open AHRS module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AHRS_reset(port, timeout=3)

Reset AHRS module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AHRS_reset_async(port)

Reset AHRS module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AHRS_start(port, timeout=3)

Start AHRS module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AHRS_start_async(port)

Start AHRS module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AHRS_stop(port, timeout=3)

Stop AHRS module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AHRS_stop_async(port)

Stop getting 3-axis estimation with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AO_close(port, timeout=3)

Close AO module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AO_close_async(port)

Close AO module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AO_getPort()

Get AO port number(s).

Parameters

None

Returns

portlist: Available AO port(s) from the device.

AO_open(port, timeout=3)

Open AO module on a given port.

Parameters

portint: Port number. See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AO_open_async(port)

Open AO module on a given port with async mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AO_writeAllChannels(port, value_list, timeout=3)

Write voltages to all channels on a given port. This should only be used in the “on demand” mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
value_listlist of float: The list of voltages in volts.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AO_writeAllChannels_async(port, value_list)

Write voltages to all channels on a given port with async mode. This should only be used in the “on demand” mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
value_listlist of float: The list of voltages in volts.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

AO_writeOneChannel(port, channel, value, timeout=3)

Write voltage to the specific channel. This should only be used in the “on demand” mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
channelint: Channel number.
valuefloat: Voltage in volts.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async AO_writeOneChannel_async(port, channel, value)

Write voltage to the specific channel with async mode. This should only be used in the “on demand” mode.

Parameters

portint: Port number. See here for available ports of different WPC devices.
channelint: Channel number.
valuefloat: Voltage in volts.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Logger_openFile(filename, clear_old=True, verbose=True)

Open CSV file.

Parameters

filenamestr: The file name.
clear_oldbool, default: True: Whether to clear old data (if the file alread exists) or not.
verbosebool, default: True: Whether to print message out.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Logger_write2DList(value_mat)

Write list of list into file.

Parameters

value_matlist of list: The list of list of data to be written.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Logger_writeHeader(header)

Write header into file.

Parameters

headerlist of str: Header to be written.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Logger_writeList(value_list)

Write list into file.

Parameters

value_listlist: The list of data to be written.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Logger_writeValue(value)

Write value into file.

Parameters

valueobject: The data to be written.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Net_getGateway(timeout=3)

Get geteway from the connected web device.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

gatewaystr of 4 int separated by period.: Network gateway.

async Net_getGateway_async()

Get geteway from the connected web device with async mode.

Returns

gatewaystr of 4 int separated by period.: Network gateway.

Net_getIPAddrAndSubmask(timeout=3)

Get IP address and subnet mask from the connected web device.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

network_infolist of 2 str.

network_info[0]: IP address
network_info[1]: subnet mask

async Net_getIPAddrAndSubmask_async()

Get IP address and subnet mask from the connected web device with async mode.

Returns

network_infolist of 2 str.

network_info[0]: IP address
network_info[1]: subnet mask

Net_getMACAddr(timeout=3)

Get MAC address from the connected web device.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

mac_addrstr of 6 int separated by colon.: MAC address.

async Net_getMACAddr_async()

Get MAC address from the connected web device with async mode.

Returns

mac_addrstr of 6 int separated by colon.: MAC address.

Net_setIPAddrAndSubmask(ip_addr, subnet_mask='255.255.255.0', timeout=3)

Set IP address and subnet mask to the connected web device.

Parameters

ip_addrstr of 4 int separated by period.: IP network address.
subnet_maskstr of 4 int separated by period.: Subnet mask. (default: “255.255.255.0”)
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Net_setIPAddrAndSubmask_async(ip_addr, subnet_mask='255.255.255.0')

Set IP address and subnet mask to the connected web device with async mode.

Parameters

ip_addrstr of 4 int separated by period.: IP network address.
subnet_maskstr of 4 int separated by period.: Subnet mask. (default: “255.255.255.0”)

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

SD_closeFile(timeout=3)

Close file in SD card.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async SD_closeFile_async()

Close file in SD card with async mode.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

SD_getStorage(timeout=3)

Get SD card storage.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

storageint: The SD card storage in MB.

async SD_getStorage_async()

Get SD card storage with async mode.

Returns

storageint: The SD card storage in MB.

SD_openFile(filename, mode, timeout=3)

Open file in SD card.

Parameters

filenamestr: The file name.
modeint: Open mode. 0: write, 1:read
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async SD_openFile_async(filename, mode)

Open file in SD card with async mode.

Parameters

filenamestr: The file name.
modeint: Open mode. 0: write, 1:read

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

SD_readFile(byte_to_read, timeout=3)

Read data from SD card.

Parameters

bytes_to_readint: The number of bytes to receive.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

datalist: The list of received data.

async SD_readFile_async(byte_to_read)

Read data from SD card with async mode.

Parameters

bytes_to_readint: The number of bytes to receive.

Returns

datalist: The list of received data.

SD_writeFile(write_data, timeout=3)

Write data in SD card.

Parameters

write_datastring or list of characters: Data to be transferred.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async SD_writeFile_async(write_data)

Write data in SD card with async mode.

Parameters

write_datastring or list of characters: Data to be transferred.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_getDeviceAlias(timeout=3)

Get device alias name.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

Alias namestring: The alias name of the device.

async Sys_getDeviceAlias_async()

Get device alias name with async mode.

Returns

Alias namestring: The alias name of the device.

Sys_getDriverInfo(timeout=3)

Get device firmware information.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

driver_infolist of three string

driver_info[0]: Model name.
driver_info[1]: Mode.
driver_info[2]: Firmware version.

async Sys_getDriverInfo_async()

Get device firmware information with async mode.

Returns

driver_infolist of three string

driver_info[0]: Model name.
driver_info[1]: Mode.
driver_info[2]: Firmware version.

Sys_getGateway(timeout=3)

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getGateway.

async Sys_getGateway_async()

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getGateway_async.

Sys_getIPAddrAndSubmask(timeout=3)

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getIPAddrAndSubmask.

async Sys_getIPAddrAndSubmask_async()

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getIPAddrAndSubmask_async.

Sys_getMACAddr(timeout=3)

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getMACAddr.

async Sys_getMACAddr_async()

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_getMACAddr_async.

Sys_getMode(slot, timeout=3)

Get the mode from a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

str_str: Mode of slot.

async Sys_getMode_async(slot)

Get the mode from a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

str_str: Mode of slot.

Sys_getPinModeInPort(port, timeout=3)

Get pin mode in specific port.

Parameters

portint: See here for available ports of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

pinsint

How many pins in specific port.

pin_modelist of 8 string

[pin0, pin1,……pin7]
pinmode : Disabled, Idle, DI, DO, UART, I2C, SPI, CAN, PWM and ADC.

async Sys_getPinModeInPort_async(port)

Get pin mode in specific port with async mode.

Parameters

portint: See here for available ports of different WPC devices.

Returns

pinsint

How many pins in specific port.

pin_modelist of 8 string

[pin0, pin1,……pin7]
pinmode : Disabled, Idle, DI, DO, UART, I2C, SPI, CAN, PWM and ADC.

Sys_getPythonVersion(timeout=3)

Get python software version.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

versionstring

async Sys_getPythonVersion_async()

Get python software version with async mode.

Returns

versionstring

Sys_getRTC(timeout=3)

Get RTC date and time.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

str_str

Date and time represented by “A-B-C, D:E:F”.

“A” is year.
“B” is month.
“C” is day.
“D” is hour.
“E” is minute.
“F” is second.

async Sys_getRTC_async()

Get RTC date and time with async mode.

Returns

str_str

Date and time represented by “A-B-C, D:E:F”.

“A” is year.
“B” is month.
“C” is day.
“D” is hour.
“E” is minute.
“F” is second.

Sys_getSerialNumber(timeout=3)

Get serial number.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

str_str: Serial number represented by string of 8 characters.

async Sys_getSerialNumber_async()

Get serial number with async mode.

Returns

str_str: Serial number represented by string of 8 characters.

Sys_reboot(timeout=3)

Reboot the device.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_reboot_async()

Reboot the device with async mode.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setAIOMode(slot, timeout=3)

Set the AIO state on a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setAIOMode_async(slot)

Set the AIO state on a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setDIMode(slot, timeout=3)

Set the DI state on a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setDIMode_async(slot)

Set the DI state on a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setDIOMode(slot, timeout=3)

Set the DIO state for the slot in the connected WPC device.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setDIOMode_async(slot)

Set the DIO state for the slot in the connected WPC device with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setDOMode(slot, timeout=3)

Set the DO state for the slot in the connected WPC device.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setDOMode_async(slot)

Set the DO state for the slot in the connected WPC device with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setDeviceAlias(alias, timeout=3)

Set the alias name of the device.

Parameters

aliasstr: The alias name of the device
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setDeviceAlias_async(alias)

Set the alias name of the device.

Parameters

aliasstr: The alias name of the device

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setIPAddrAndSubmask(ip_addr, subnet_mask='255.255.255.0', timeout=3)

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_setIPAddrAndSubmask.

async Sys_setIPAddrAndSubmask_async(ip_addr, subnet_mask='255.255.255.0')

Deprecated in v1.0.5. Will be removed in v1.2.0.

See :ref:Net_setIPAddrAndSubmask_async.

Sys_setIdleMode(slot, timeout=3)

Set the IDLE state on a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setIdleMode_async(slot)

Set the IDLE state on a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setMotionMode(slot, timeout=3)

Set the motion state on a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setMotionMode_async(slot)

Set the motion state on a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setRTC(year, month, day, hour, minute, second, timeout=3)

Set RTC date and time.

Parameters

yearint: year (CE).
monthint: month (1~12).
dayint: day (1~31).
hourint: hour (24-hour clock) (0~23).
minuteint: minute (0~59).
secondint: second (0~59).
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setRTC_async(year, month, day, hour, minute, second)

Set RTC date and time with async mode.

Parameters

yearint: year (CE).
monthint: month (1~12).
dayint: day (1~31).
hourint: hour (24-hour clock) (0~23).
minuteint: minute (0~59).
secondint: second (0~59).

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_setSwitchMode(slot, timeout=3)

Set the switch state on a given slot.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_setSwitchMode_async(slot)

Set the switch state on a given slot with async mode.

Parameters

slotint: Slot number. See here for available slot of different WPC devices.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_startRTCAlarm(mode, day, hour, minute, second, timeout=3)

Start RTC time to alarm AI.

Parameters

modeint: 0: Day value interpreted as calendar day. 1: Day value interpreted as weekday.
dayint: Celendar day (1~31)/ Weekday (1~7).
hourint: hour (24-hour clock) (0~23).
minuteint: minute (0~59).
secondint: second (0~59).
timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_startRTCAlarm_async(mode, day, hour, minute, second)

Start RTC time to alarm AI with async mode.

Parameters

modeint: 0: Day value interpreted as calendar day. 1: Day value interpreted as weekday.
dayint: Celendar day (1~31)/ Weekday (1~7).
hourint: hour (24-hour clock) (0~23).
minuteint: minute (0~59).
secondint: second (0~59).

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Sys_stopRTCAlarm(timeout=3)

Stop alarming.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Sys_stopRTCAlarm_async()

Stop alarming with async mode.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Wifi_getChargeStatus(timeout=3)

Get status about the battery being charged from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Charge status.

async Wifi_getChargeStatus_async()

Get status about the battery being charged from WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Charge status.

Wifi_getConfiguration(timeout=3)

Get reconnection times and AP stay time from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

wifi_configurationlist of 2 positive int.

wifi_configuration[0]: Wifi connection retry times
wifi_configuration[1]: Time of staying in AP mode in second

async Wifi_getConfiguration_async()

Get reconnection times and AP stay time from WifiDAQ with async mode.

Returns

wifi_configurationlist of 2 positive int.

wifi_configuration[0]: Wifi connection retry times
wifi_configuration[1]: Time of staying in AP mode in second

Wifi_getPowerGoodStatus(timeout=3)

Get status about the battery being fully charged from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Battery status.

async Wifi_getPowerGoodStatus_async()

Get status about the battery being fully charged from WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Battery status.

Wifi_getWifiBandWidth(timeout=3)

Get the bandwidth from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

bandwidthint

1 : bandwidth is HT20.
2 : bandwidth is HT40.

async Wifi_getWifiBandWidth_async()

Get the bandwidth from WifiDAQ with async mode.

Returns

bandwidthint

1 : bandwidth is HT20.
2 : bandwidth is HT40.

Wifi_readBattery(timeout=3)

Get volatge of battery from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

batteryint: Battery level in mV.

async Wifi_readBattery_async()

Get volatge of battery from WifiDAQ with async mode.

Returns

batteryint: Battery level in mV.

Wifi_readRSSI(timeout=3)

Read the signal strength from WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

rssiint: RSSI signal in dBm.

async Wifi_readRSSI_async()

Read the signal strength from WifiDAQ with async mode.

Returns

rssiint: RSSI signal in dBm.

Wifi_resetLED(timeout=3)

Reset LED to WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Wifi_resetLED_async()

Reset LED to WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Wifi_setBlueLED(value, timeout=3)

Set the blue LED status, while turning off the others to WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Wifi_setBlueLED_async(value)

Set the blue LED status, while turning off the others to WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Wifi_setGreenLED(value, timeout=3)

Set the green LED status, while turning off the others to WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Wifi_setGreenLED_async(value)

Set the green LED status, while turning off the others to WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

Wifi_setRedLED(value, timeout=3)

Set the red LED status, while turning off the others to WifiDAQ.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

async Wifi_setRedLED_async(value)

Set the red LED status, while turning off the others to WifiDAQ with async mode.

Parameters

timeoutint: Specify the time (sec) to wait before reporting a timeout error. The default is 3 s.
valueint: High(1) or low(0) value.

Returns

statusint: Return 0 if executed successfully; return error code otherwise. See here for corresponding error messages.

close()

Close wifi device handle.

Parameters

verbose: bool, default: True: Whether to print out messages or not.

Returns

None

connect(ip)

Connect handle to wifi device.

Parameters

ipstr of 4 int separated by period.: IP network address of the WPC device to connect to.
port1int, default: 7: TCP port for commands.
port2int, default: 1336: TCP port for data.
verbose: bool, default: True: Whether to print out messages or not.

Returns

None

disconnect()

Disconnect handle from wifi device.

Parameters

verbose: bool, default: True: Whether to print out messages or not.

Returns

None