Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:configuration_api [2023/08/16 15:02] mashin |
en:configuration_api [2023/08/31 18:35] kkshin [BS2SystemConfig] |
||
---|---|---|---|
Line 86: | Line 86: | ||
* [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] Get the LED/buzzer settings for each action of the OSDP device. | * [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] Get the LED/buzzer settings for each action of the OSDP device. | ||
* [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] Specifies the LED/buzzer setting for each action of the OSDP device. | * [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] Specifies the LED/buzzer setting for each action of the OSDP device. | ||
+ | * [[BS2_GetCustomCardConfig]]: [+ 2.9.4] Retrieves Custom smart card settings. | ||
+ | * [[BS2_SetCustomCardConfig]]: [+ 2.9.4] Stores Custom smart card settings. | ||
\\ | \\ | ||
===== Structure ===== | ===== Structure ===== | ||
Line 200: | Line 202: | ||
Also, the required card type MASK should be combined with ''CARD_OPERATION_USE''. \\ | Also, the required card type MASK should be combined with ''CARD_OPERATION_USE''. \\ | ||
For example, useCardOperationMask needs to be configured ''x0x80000001'' when EM card is selected only. | For example, useCardOperationMask needs to be configured ''x0x80000001'' when EM card is selected only. | ||
- | <WRAP group 50%> | + | <WRAP group 60%> |
^Value ^Description ^ | ^Value ^Description ^ | ||
|0xFFFFFFFF |CARD_OPERATION_MASK_DEFAULT | | |0xFFFFFFFF |CARD_OPERATION_MASK_DEFAULT | | ||
|0x80000000 |CARD_OPERATION_USE | | |0x80000000 |CARD_OPERATION_USE | | ||
+ | |0x00000000 |CARD_OPERATION_MASK_NONE | | ||
+ | |0x00000800 |CARD_OPERATION_MASK_CUSTOM_DESFIRE_EV1 | | ||
+ | |0x00000400 |CARD_OPERATION_MASK_CUSTOM_CLASSIC_PLUS | | ||
|0x00000200 |CARD_OPERATION_MASK_BLE | | |0x00000200 |CARD_OPERATION_MASK_BLE | | ||
|0x00000100 |CARD_OPERATION_MASK_NFC | | |0x00000100 |CARD_OPERATION_MASK_NFC | | ||
Line 2488: | Line 2493: | ||
Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ | Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ | ||
and a separate license activation is required to use this feature. \\ | and a separate license activation is required to use this feature. \\ | ||
- | License activation is supported through [[qr_code_api#BS2_EnableBarcodeLicense]]. \\ \\ | + | License activation is supported through [[BS2_EnableDeviceLicense]]. \\ \\ |
6. //motionSensitivity// \\ | 6. //motionSensitivity// \\ | ||
[+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ | [+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ | ||
Line 2877: | Line 2882: | ||
Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ | Visual barcode scans QR code with a general visual camera instead of a QR code sensor, \\ | ||
and a separate license activation is required to use this feature. \\ | and a separate license activation is required to use this feature. \\ | ||
- | License activation is supported through [[qr_code_api#BS2_EnableBarcodeLicense]]. \\ \\ | + | License activation is supported through [[BS2_EnableDeviceLicense]]. \\ \\ |
6. //motionSensitivity// \\ | 6. //motionSensitivity// \\ | ||
[+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ | [+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\ | ||
Line 3203: | Line 3208: | ||
10. //desfireAppKey// \\ | 10. //desfireAppKey// \\ | ||
Indicates key information to access DesFire card information. (Advanced settings) \\ \\ | Indicates key information to access DesFire card information. (Advanced settings) \\ \\ | ||
+ | |||
+ | |||
+ | ==== BS2CustomCardConfig ==== | ||
+ | <code cpp> | ||
+ | typedef struct { | ||
+ | BS2_CARD_DATA_TYPE dataType; | ||
+ | BS2_BOOL useSecondaryKey; | ||
+ | uint8_t reserved1[2]; | ||
+ | |||
+ | BS2CustomMifareCard mifare; | ||
+ | BS2CustomDesFireCard desfire; | ||
+ | uint8_t reserved2[24]; | ||
+ | uint8_t reserved3[96]; | ||
+ | |||
+ | BS2_CARD_BYTE_ORDER smartCardByteOrder; | ||
+ | uint8_t reserved4[3]; | ||
+ | BS2_UID formatID; | ||
+ | uint8_t reserved5[8]; | ||
+ | } BS2CustomCardConfig; | ||
+ | </code> | ||
+ | 1. //dataType// \\ | ||
+ | Type of card data. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |Binary | | ||
+ | |1 |ASCII | | ||
+ | |2 |UTF16 | | ||
+ | |3 |BCD | | ||
+ | </WRAP> | ||
+ | 2. //useSecondaryKey// \\ | ||
+ | Decides whether to use the secondary encryption key. \\ \\ | ||
+ | 3. //reserved1// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 4. //mifare// \\ | ||
+ | Set the Mifare custom card information. \\ \\ | ||
+ | 5. //desfire// \\ | ||
+ | Set the DESFire custom card information. \\ \\ | ||
+ | 6. //reserved2// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 7. //reserved3// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 8. //smartCardByteOrder// \\ | ||
+ | The output method can be selected from MSB or LSB. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^Value ^Description ^ | ||
+ | |0 |MSB | | ||
+ | |1 |LSB | | ||
+ | </WRAP> | ||
+ | 9. //reserved4// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 10. //formatID// \\ | ||
+ | This is an identifier that can be used when the BioStar 2 application needs to manage the card configuration as a database. \\ \\ | ||
+ | 11. //reserved5// \\ | ||
+ | Reserved space. \\ \\ |