Differences

This shows you the differences between two versions of the page.

--- en:configuration_api [2023/03/02 15:21]
kkshin [BS2BarcodeConfig]
+++ en:configuration_api [2023/09/01 08:37]
127.0.0.1 external edit
@@ Line 86: / Line 86: @@
   * [[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_GetCustomCardConfig]]: [+ 2.9.4] Retrieves Custom smart card settings.
+  * [[BS2_SetCustomCardConfig]]: [+ 2.9.4] Stores Custom smart card settings.
 \\
 ===== Structure =====
@@ Line 200: / Line 202: @@
 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.
-<WRAP group 50%>
+<WRAP group 60%>
 ^Value  ^Description ^
 |0xFFFFFFFF  |CARD_OPERATION_MASK_DEFAULT  |
 |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  |
 |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, \\
 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]]. \\ \\
 . //motionSensitivity// \\
 [+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, \\
 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]]. \\ \\
 . //motionSensitivity// \\
 [+2.9.1] Set the sensitivity of motion sensor for visual barcode. \\
@@ Line 3123: / Line 3128: @@
 . //actions// \\
 LED/buzzer information for OSDP devices, up to 32 can be designated. \\ \\
+==== BS2CustomMifareCard ====
+<code cpp>
+typedef struct {
+	uint8_t primaryKey[6];
+	uint8_t reserved1[2];
+	uint8_t secondaryKey[6];
+	uint8_t reserved2[2];
+	uint16_t startBlockIndex;
+	uint8_t dataSize;
+	uint8_t skipBytes;
+	uint8_t reserved[4];
+} BS2CustomMifareCard;
+</code>
+. //primaryKey// \\
+Primary encryption key to access the Mifare card information. \\ \\
+. //reserved1// \\
+Reserved space.\\ \\
+. //secondaryKey// \\
+Secondary encryption key to access the Mifare card information. \\ \\
+. //reserved2// \\
+Reserved space.\\ \\
+. //startBlockIndex// \\
+Start block index on the Mifare data storage.\\ \\
+. //dataSize// \\
+The size in bytes of the card data. \\ \\
+. //skipBytes// \\
+This is where the card data appears. \\
+This is the starting point to read card data. It is 0 when reading from the starting point, and indicates the number of bytes skipped after the first. \\ \\
+. //reserved// \\
+Reserved space.\\ \\
+==== BS2CustomDesFireCard ====
+<code cpp>
+typedef struct {
+	uint8_t primaryKey[16];
+	uint8_t secondaryKey[16];
+	uint8_t appID[3];
+	uint8_t fileID;
+	uint8_t encryptionType;                 // 0: DES/3DES, 1: AES
+	uint8_t operationMode;                  // 0: legacy(use picc master key), 1: new mode(use app master, file read, file write key)
+	uint8_t dataSize;
+	uint8_t skipBytes;
+	uint8_t reserved[4];
+	BS2DesFireAppLevelKey desfireAppKey;		///<52 bytes
+} BS2CustomDesFireCard;                           ///<96 Bytes
+</code>
+. //primaryKey// \\
+Primary encryption key to access the DesFire card information. (General settings) \\ \\
+. //secondaryKey// \\
+Secondary encryption key to access the Desfire card information. (General settings) \\ \\
+. //appID// \\
+Application Id that is stored inside the DesFire card for user authentication.\\ \\
+. //fileID// \\
+File ID that is stored inside the DesFire card, which will be used by the application to read and write data.\\ \\
+. //encryptionType// \\
+Type of data encryption.\\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |DES/3DES  |
+|1  |AES  |
+</WRAP>
+. //operationMode// \\
+Operation mode. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Using general settings (Using PICC master key)  |
+|1  |Using advanced settings (Using App master key)  |
+</WRAP>
+. //dataSize// \\
+The size in bytes of the card data. \\ \\
+. //skipBytes// \\
+This is where the card data appears. \\
+This is the starting point to read card data. It is 0 when reading from the starting point, and indicates the number of bytes skipped after the first. \\ \\
+. //reserved// \\
+Reserved space.\\ \\
+. //desfireAppKey// \\
+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>
+. //dataType// \\
+Type of card data. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Binary  |
+|1  |ASCII  |
+|2  |UTF16  |
+|3  |BCD  |
+</WRAP>
+. //useSecondaryKey// \\
+Decides whether to use the secondary encryption key. \\ \\
+. //reserved1// \\
+Reserved space. \\ \\
+. //mifare// \\
+Set the Mifare custom card information. \\ \\
+. //desfire// \\
+Set the DESFire custom card information. \\ \\
+. //reserved2// \\
+Reserved space. \\ \\
+. //reserved3// \\
+Reserved space. \\ \\
+. //smartCardByteOrder// \\
+The output method can be selected from MSB or LSB. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |MSB  |
+|1  |LSB  |
+</WRAP>
+. //reserved4// \\
+Reserved space. \\ \\
+. //formatID// \\
+This is an identifier that can be used when the BioStar 2 application needs to manage the card configuration as a database. \\ \\
+. //reserved5// \\
+Reserved space. \\ \\