Device Information

Use the following calls to get information about the system setup or state of the paired Sparrow Link Pulse Generator.

System Information

ReadSerial

ReadSerial
(
, 
)

Returns the last 6 digits of the serial number (SN) for the paired Pulse Generator.

Params
required
required
Return Value
Serial
string

Example: ‘123456’

ReadModel

ReadModel
(
, 
)

Returns the model number of the paired Pulse Generator.

Params
required
required
Return Value
Model
string

Example: Sparrow Link Pulse Generators return ‘910’

ReadManufacturer

ReadManufacturer
(
, 
)

Returns the full serial number of the paired Pulse Generator.

Params
required
required
Return Value
Serial
string

Example: ‘X2150211201’

ReadFirmware

ReadFirmware
(
, 
)

Returns the firmware version of the paired Pulse Generator.

Params
required
required
Return Value
Version
string

Example: ’03.00.12’

ReadHardware

ReadHardware
(
, 
)

Returns the hardware version of the paired Pulse Generator.

Params
required
required
Return Value
Version
string

Example: ’02.00.12’

System Time

Use the following calls to set or check the system time of the paired Sparrow Link Pulse Generator.

SetSystemTime

SetSystemTime
(
Seconds
, 
)

Sets the date and time to the parameter entered.

Params
Seconds
string
required

Seconds of time since epoch.

required
Return Value

SetSystemCurrentTime

SetSystemCurrentTime
(
, 
)

Sets the date and time to match the system date and time of the computer powering the Hub.

Params
required
required
Return Value

ReadSystemTime

ReadSystemTime
(
, 
)

Gets the date and time set on the Pulse Generator.

Params
required
required
Return Value
Time
timestamp

Example; ‘TimeStamp,MM/DD/YYYY HH:MM:SS,’

History

Device history captures Pulse Generator use and changes to device settings. Call ClearHistory() to erase all device history records.

To retrieve the device logs from the Sparrow Link Pulse Generator, call SaveHistory() or connect the Pulse Generator to the Sparrow Link Mobile App and use the Share Logs feature to download the logs to the tablet or mobile device running the mobile app. The logs will be downloaded in a .CSV format to the local folder or the device’s internal storage, respectively.

‍

ClearHistory

ClearHistory
(
, 
)

Erases all device history records.

Params
required
required
Return Value

SaveHistory

SaveHistory
(
Filename
, 
Duration
)

Saves device history records as a csv.

Params
Filename
string
required

The name of the file to be created with the exported history data. For example: 'filename.csv'.

Important: be sure to include the ".csv" file extension.

Duration
string
required

String representing the time period for which the history records should be saved.

'Today': Saves device history records from that day, based on the system date at which the computer is set.
‍'All': Saves all device history records.
'mmddyyyy','mmddyyyy': Saves device history records between the two specified dates.

Return Value
On this page
Method