Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:server_api [2021/08/05 15:49] peter Server API |
en:server_api [2024/04/09 19:04] (current) alex [Server API] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| API that can enable server matching or controls the device from the BioStar application. \\ | API that can enable server matching or controls the device from the BioStar application. \\ | ||
| <callout type="warning" icon="true"><WRAP em>Warning</WRAP> \\ | <callout type="warning" icon="true"><WRAP em>Warning</WRAP> \\ | ||
| - | Due to the issues with the management of UFMatcher.dll which was provided by an other independent Corporation, Runnable examples are not provided anymore. \\ | + | Due to the issues with the management of UFMatcher.dll which was provided by a separate independent Corporation, Runnable examples will not be available anymore. \\ |
| Please reference the prior examples at the code level only. \\ \\ | Please reference the prior examples at the code level only. \\ \\ | ||
| Other technical supports including libraries for server matching can be provided by SupremaID sales team. \\ | Other technical supports including libraries for server matching can be provided by SupremaID sales team. \\ | ||
| - | <wrap hi>SupremaID : sales_id@supremainc.com</wrap> \\ | + | <wrap hi>Suprema ID : sales_id@supremainc.com</wrap> \\ |
| - | + | ||
| - | + | ||
| - | + | ||
| </callout> | </callout> | ||
| Line 25: | Line 21: | ||
| * [[BS2_SetUserPhraseHandler]]: [+ 2.7.0] Registers the server user phrase handler. | * [[BS2_SetUserPhraseHandler]]: [+ 2.7.0] Registers the server user phrase handler. | ||
| * [[BS2_ResponseUserPhrase]]: [+ 2.7.0] Transfers the user phrase to the device. | * [[BS2_ResponseUserPhrase]]: [+ 2.7.0] Transfers the user phrase to the device. | ||
| + | * [[BS2_SetBarcodeScanListener]]: [+2.8.2] Register the listener function that detects barcode input. | ||
| + | * [[BS2_SetOsdpStandardDeviceStatusListener]]: [+ 2.9.1] Register a listener function that detects state changes of the OSDP device. | ||
| ===== Callback Function ====== | ===== Callback Function ====== | ||
| <code cpp> | <code cpp> | ||
| Line 50: | Line 48: | ||
| 3. //userID// \\ | 3. //userID// \\ | ||
| User ID \\ \\ | User ID \\ \\ | ||
| + | |||
| + | ==== OnBarcodeScanned ==== | ||
| + | Callback function called when barcode is scanned on the device. \\ \\ | ||
| + | <code cpp> | ||
| + | typedef void (*OnBarcodeScanned)(uint32_t deviceId, const char* barcode); | ||
| + | </code> | ||
| + | \\ | ||
| + | 1. //deviceId// \\ | ||
| + | Device ID that sent the scanned barcode. \\ \\ | ||
| + | 2. //barcode// \\ | ||
| + | Barcode string read from device. \\ \\ | ||
| + | |||
| + | |||
| + | ==== OnOsdpStandardDeviceStatusChanged ==== | ||
| + | This is a callback function that is called when the state of the OSDP device changes. \\ \\ | ||
| + | <code cpp> | ||
| + | typedef void (*OnOsdpStandardDeviceStatusChanged)(uint32_t deviceId, const BS2OsdpStandardDeviceNotify* notifyData); | ||
| + | </code> | ||
| + | \\ | ||
| + | 1. //deviceId// \\ | ||
| + | OSDP device identifier. \\ \\ | ||
| + | 2. //notifyData// \\ | ||
| + | OSDP device information. \\ \\ | ||