├── .github └── FUNDING.yml ├── FingerPrint.c ├── FingerPrint.h ├── FingerPrintConfig.h ├── FingerPrintUser.c ├── LICENSE └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [nimaltd] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: nimaltd 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /FingerPrint.c: -------------------------------------------------------------------------------- 1 | 2 | #include "FingerPrint.h" 3 | #include "FingerPrintConfig.h" 4 | #include "usart.h" 5 | #include "task.h" 6 | #include 7 | 8 | 9 | 10 | 11 | //######################################################################################################################### 12 | #define FINGERPRINT_OK 0x00 13 | #define FINGERPRINT_PACKETRECIEVEERR 0x01 14 | #define FINGERPRINT_NOFINGER 0x02 15 | #define FINGERPRINT_IMAGEFAIL 0x03 16 | #define FINGERPRINT_IMAGEMESS 0x06 17 | #define FINGERPRINT_FEATUREFAIL 0x07 18 | #define FINGERPRINT_NOMATCH 0x08 19 | #define FINGERPRINT_NOTFOUND 0x09 20 | #define FINGERPRINT_ENROLLMISMATCH 0x0A 21 | #define FINGERPRINT_BADLOCATION 0x0B 22 | #define FINGERPRINT_DBRANGEFAIL 0x0C 23 | #define FINGERPRINT_UPLOADFEATUREFAIL 0x0D 24 | #define FINGERPRINT_PACKETRESPONSEFAIL 0x0E 25 | #define FINGERPRINT_UPLOADFAIL 0x0F 26 | #define FINGERPRINT_DELETEFAIL 0x10 27 | #define FINGERPRINT_DBCLEARFAIL 0x11 28 | #define FINGERPRINT_PASSFAIL 0x13 29 | #define FINGERPRINT_INVALIDIMAGE 0x15 30 | #define FINGERPRINT_FLASHERR 0x18 31 | #define FINGERPRINT_INVALIDREG 0x1A 32 | #define FINGERPRINT_ADDRCODE 0x20 33 | #define FINGERPRINT_PASSVERIFY 0x21 34 | 35 | #define FINGERPRINT_STARTCODE_BYTE0 0xEF 36 | #define FINGERPRINT_STARTCODE_BYTE1 0x01 37 | 38 | #define FINGERPRINT_COMMANDPACKET 0x1 39 | #define FINGERPRINT_DATAPACKET 0x2 40 | #define FINGERPRINT_ACKPACKET 0x7 41 | #define FINGERPRINT_ENDDATAPACKET 0x8 42 | 43 | #define FINGERPRINT_TIMEOUT 0xFF 44 | #define FINGERPRINT_BADPACKET 0xFE 45 | 46 | #define FINGERPRINT_GETIMAGE 0x01 47 | #define FINGERPRINT_IMAGE2TZ 0x02 48 | #define FINGERPRINT_SEARCH 0x04 49 | #define FINGERPRINT_REGMODEL 0x05 50 | #define FINGERPRINT_STORE 0x06 51 | #define FINGERPRINT_LOAD 0x07 52 | #define FINGERPRINT_UPLOAD 0x08 53 | #define FINGERPRINT_DELETE 0x0C 54 | #define FINGERPRINT_EMPTY 0x0D 55 | #define FINGERPRINT_SETPASSWORD 0x12 56 | #define FINGERPRINT_VERIFYPASSWORD 0x13 57 | #define FINGERPRINT_HISPEEDSEARCH 0x1B 58 | #define FINGERPRINT_TEMPLATECOUNT 0x1D 59 | //######################################################################################################################### 60 | osThreadId FingerPrintTaskHandle; 61 | osThreadId FingerPrintBufferHandle; 62 | 63 | FingerPrint_t FingerPrint; 64 | 65 | 66 | //######################################################################################################################### 67 | void FingerPrint_RxCallback(void) 68 | { 69 | FingerPrint.RxLastTime=HAL_GetTick(); 70 | FingerPrint.RxBuffer[FingerPrint.RxIndex] = FingerPrint.RxTmp; 71 | if(FingerPrint.RxIndex= 0) 107 | FingerPrint_Detect(FingerPrint.LastDetectedLocation); 108 | while(HAL_GPIO_ReadPin(_FINGERPRINT_IRQ_GPIO,_FINGERPRINT_IRQ_PIN)==GPIO_PIN_RESET) 109 | osDelay(500); 110 | osDelay(500); 111 | } 112 | //--- Finger pressed and do job 113 | osDelay(100); 114 | } 115 | } 116 | //######################################################################################################################### 117 | void FingerPrintBufferTask(void const * argument) 118 | { 119 | osDelay(100); 120 | while(1) 121 | { 122 | //+++ Serial process 123 | if((HAL_GetTick()-FingerPrint.RxLastTime > 100) && (FingerPrint.RxIndex>0)) 124 | { 125 | //+++ Rx Data from Sensor 126 | if((FingerPrint.RxBuffer[0]==0xEF) && (FingerPrint.RxBuffer[1]==0x01) && (FingerPrint.RxBuffer[2]==0xFF) && (FingerPrint.RxBuffer[3]==0xFF) && (FingerPrint.RxBuffer[4]==0xFF) && (FingerPrint.RxBuffer[5]==0xFF) && (FingerPrint.RxBuffer[6]==0x07)) 127 | { 128 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 129 | memcpy(FingerPrint.AnswerBuffer,&FingerPrint.RxBuffer[7],FingerPrint.RxBuffer[8]+2); 130 | FingerPrint.GotAnswer=1; 131 | } 132 | //--- Rx Data from Sensor 133 | memset(FingerPrint.RxBuffer,0,sizeof(FingerPrint.RxBuffer)); 134 | FingerPrint.RxIndex=0; 135 | } 136 | //--- Serial process 137 | osDelay(100); 138 | } 139 | } 140 | //######################################################################################################################### 141 | void FingerPrint_Init(osPriority Priority) 142 | { 143 | osThreadDef(NameFingerPrintTask, FingerPrintTask, Priority, 0, 128); 144 | FingerPrintTaskHandle = osThreadCreate(osThread(NameFingerPrintTask), NULL); 145 | osThreadDef(NameFingerPrintBufferTask, FingerPrintBufferTask, Priority, 0, 128); 146 | FingerPrintBufferHandle = osThreadCreate(osThread(NameFingerPrintBufferTask), NULL); 147 | osDelay(200); 148 | FingerPrint_ReadTemplateNumber(); 149 | } 150 | //######################################################################################################################### 151 | bool Fingerprint_VerifyPassword(uint32_t pass) 152 | { 153 | uint16_t checksum=0; 154 | if(FingerPrint.Lock==1) 155 | return false; 156 | FingerPrint.Lock=1; 157 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 158 | osDelay(500); 159 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 160 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 161 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 162 | FingerPrint.TxBuffer[2]=0xFF; 163 | FingerPrint.TxBuffer[3]=0xFF; 164 | FingerPrint.TxBuffer[4]=0xFF; 165 | FingerPrint.TxBuffer[5]=0xFF; 166 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 167 | FingerPrint.TxBuffer[7]=0x00; 168 | FingerPrint.TxBuffer[8]=0x07; 169 | FingerPrint.TxBuffer[9]=FINGERPRINT_VERIFYPASSWORD; 170 | FingerPrint.TxBuffer[10]=pass>>24; 171 | FingerPrint.TxBuffer[11]=pass>>16; 172 | FingerPrint.TxBuffer[12]=pass>>8; 173 | FingerPrint.TxBuffer[13]=pass&0x000000FF; 174 | for(uint8_t i=6 ; i<=13 ; i++) 175 | checksum+=FingerPrint.TxBuffer[i]; 176 | FingerPrint.TxBuffer[14] = checksum >> 8; 177 | FingerPrint.TxBuffer[15] = checksum & 0x00FF; 178 | 179 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,16,100); 180 | osDelay(200); 181 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 182 | FingerPrint.Lock=0; 183 | if(FingerPrint.GotAnswer==1) 184 | { 185 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 186 | { 187 | FingerPrint.Lock=0; 188 | return true; 189 | } 190 | else 191 | { 192 | FingerPrint.Lock=0; 193 | return false; 194 | } 195 | } 196 | else 197 | { 198 | FingerPrint.Lock=0; 199 | return false; 200 | } 201 | } 202 | //######################################################################################################################### 203 | bool Fingerprint_SaveNewFinger(uint16_t Location,uint8_t WaitForFingerInSecond) 204 | { 205 | uint8_t TimeOut; 206 | if(FingerPrint.Lock==1) 207 | return false; 208 | FingerPrint.Lock=1; 209 | FingerPrint.GotAnswer=0; 210 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 211 | osDelay(500); 212 | //+++ take Image 213 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 214 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 215 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 216 | FingerPrint.TxBuffer[2]=0xFF; 217 | FingerPrint.TxBuffer[3]=0xFF; 218 | FingerPrint.TxBuffer[4]=0xFF; 219 | FingerPrint.TxBuffer[5]=0xFF; 220 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 221 | FingerPrint.TxBuffer[7]=0x00; 222 | FingerPrint.TxBuffer[8]=0x03; 223 | FingerPrint.TxBuffer[9]=FINGERPRINT_GETIMAGE; 224 | FingerPrint.TxBuffer[10]=0x00; 225 | FingerPrint.TxBuffer[11]=0x05; 226 | TimeOut=0; 227 | while(TimeOut < WaitForFingerInSecond) 228 | { 229 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 230 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 231 | osDelay(1000); 232 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 233 | break; 234 | TimeOut++; 235 | if(TimeOut==WaitForFingerInSecond) 236 | goto Faild; 237 | } 238 | //--- take Image 239 | //+++ put image to buffer 1 240 | do 241 | { 242 | FingerPrint.TxBuffer[8]=0x04; 243 | FingerPrint.TxBuffer[9]=FINGERPRINT_IMAGE2TZ; 244 | FingerPrint.TxBuffer[10]=1; 245 | FingerPrint.TxBuffer[11]=0x00; 246 | FingerPrint.TxBuffer[12]=0x08; 247 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 248 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,13,100); 249 | osDelay(1000); 250 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 251 | break; 252 | else 253 | goto Faild; 254 | }while(0); 255 | //--- put image to buffer 1 256 | 257 | //+++ Wait for put your finger up 258 | TimeOut=0; 259 | while(TimeOut < WaitForFingerInSecond) 260 | { 261 | osDelay(1000); 262 | TimeOut++; 263 | if(TimeOut==WaitForFingerInSecond) 264 | goto Faild; 265 | if( HAL_GPIO_ReadPin(_FINGERPRINT_IRQ_GPIO,_FINGERPRINT_IRQ_PIN)==GPIO_PIN_SET) 266 | break; 267 | } 268 | //--- Wait for put your finger up 269 | 270 | //+++ take Image 271 | FingerPrint.TxBuffer[8]=0x03; 272 | FingerPrint.TxBuffer[9]=FINGERPRINT_GETIMAGE; 273 | FingerPrint.TxBuffer[10]=0x00; 274 | FingerPrint.TxBuffer[11]=0x05; 275 | TimeOut=0; 276 | while(TimeOut < WaitForFingerInSecond) 277 | { 278 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 279 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 280 | osDelay(1000); 281 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 282 | break; 283 | TimeOut++; 284 | if(TimeOut==WaitForFingerInSecond) 285 | goto Faild; 286 | } 287 | //--- take Image 288 | 289 | //+++ put image to buffer 2 290 | do 291 | { 292 | FingerPrint.TxBuffer[8]=0x04; 293 | FingerPrint.TxBuffer[9]=FINGERPRINT_IMAGE2TZ; 294 | FingerPrint.TxBuffer[10]=2; 295 | FingerPrint.TxBuffer[11]=0x00; 296 | FingerPrint.TxBuffer[12]=0x09; 297 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 298 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,13,100); 299 | osDelay(1000); 300 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 301 | break; 302 | else 303 | goto Faild; 304 | }while(0); 305 | //--- put image to buffer 2 306 | 307 | //+++ Wait for put your finger up 308 | TimeOut=0; 309 | while(TimeOut < WaitForFingerInSecond) 310 | { 311 | osDelay(1000); 312 | TimeOut++; 313 | if(TimeOut==WaitForFingerInSecond) 314 | goto Faild; 315 | if( HAL_GPIO_ReadPin(_FINGERPRINT_IRQ_GPIO,_FINGERPRINT_IRQ_PIN)==GPIO_PIN_SET) 316 | break; 317 | } 318 | //--- Wait for put your finger up 319 | 320 | //+++ Create Register model 321 | do 322 | { 323 | FingerPrint.TxBuffer[8]=0x03; 324 | FingerPrint.TxBuffer[9]=FINGERPRINT_REGMODEL; 325 | FingerPrint.TxBuffer[10]=0x00; 326 | FingerPrint.TxBuffer[11]=0x09; 327 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 328 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 329 | osDelay(1000); 330 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 331 | break; 332 | else 333 | goto Faild; 334 | 335 | }while(0); 336 | //--- Create Register model 337 | 338 | //+++ Store in memory 339 | do 340 | { 341 | FingerPrint.TxBuffer[8]=0x06; 342 | FingerPrint.TxBuffer[9]=FINGERPRINT_STORE; 343 | FingerPrint.TxBuffer[10]=0x01; 344 | FingerPrint.TxBuffer[11]=Location>>8; 345 | FingerPrint.TxBuffer[12]=Location&0x00ff; 346 | uint8_t Checksum=0; 347 | for(uint8_t i=0;i<9; i++) 348 | Checksum+=FingerPrint.TxBuffer[i+6]; 349 | FingerPrint.TxBuffer[13]=Checksum>>8; 350 | FingerPrint.TxBuffer[14]=Checksum&0x00FF; 351 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 352 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,15,100); 353 | osDelay(1000); 354 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 355 | break; 356 | else 357 | goto Faild; 358 | 359 | }while(0); 360 | //--- Store in memory 361 | 362 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 363 | FingerPrint.Lock=0; 364 | FingerPrint_ReadTemplateNumber(); 365 | return true; 366 | 367 | Faild: 368 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 369 | FingerPrint.Lock=0; 370 | return false; 371 | } 372 | //######################################################################################################################### 373 | int16_t FingerPrint_Scan(void) 374 | { 375 | uint8_t Timeout; 376 | if(FingerPrint.Lock==1) 377 | return -1; 378 | FingerPrint.Lock=1; 379 | FingerPrint.GotAnswer=0; 380 | uint8_t IfModuleIsOff=0; 381 | if(HAL_GPIO_ReadPin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN)==GPIO_PIN_RESET) 382 | IfModuleIsOff=1; 383 | //+++ take Image 384 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 385 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 386 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 387 | FingerPrint.TxBuffer[2]=0xFF; 388 | FingerPrint.TxBuffer[3]=0xFF; 389 | FingerPrint.TxBuffer[4]=0xFF; 390 | FingerPrint.TxBuffer[5]=0xFF; 391 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 392 | FingerPrint.TxBuffer[7]=0x00; 393 | FingerPrint.TxBuffer[8]=0x03; 394 | FingerPrint.TxBuffer[9]=FINGERPRINT_GETIMAGE; 395 | FingerPrint.TxBuffer[10]=0x00; 396 | FingerPrint.TxBuffer[11]=0x05; 397 | do 398 | { 399 | if(IfModuleIsOff==1) 400 | { 401 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 402 | osDelay(500); 403 | } 404 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 405 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 406 | for(Timeout=0; Timeout<20 ; Timeout++) 407 | { 408 | osDelay(100); 409 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 410 | break; 411 | } 412 | if(Timeout>19) 413 | goto Faild; 414 | }while(0); 415 | //--- take Image 416 | 417 | //+++ put image to buffer 1 418 | do 419 | { 420 | FingerPrint.TxBuffer[8]=0x04; 421 | FingerPrint.TxBuffer[9]=FINGERPRINT_IMAGE2TZ; 422 | FingerPrint.TxBuffer[10]=1; 423 | FingerPrint.TxBuffer[11]=0x00; 424 | FingerPrint.TxBuffer[12]=0x08; 425 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 426 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,13,100); 427 | for(Timeout=0; Timeout<20 ; Timeout++) 428 | { 429 | osDelay(100); 430 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 431 | break; 432 | if(Timeout>19) 433 | goto Faild; 434 | } 435 | }while(0); 436 | //--- put image to buffer 1 437 | 438 | //+++ Searching 439 | do 440 | { 441 | FingerPrint.TxBuffer[8]=0x08; 442 | FingerPrint.TxBuffer[9]=FINGERPRINT_SEARCH; 443 | FingerPrint.TxBuffer[10]=1; 444 | FingerPrint.TxBuffer[11]=0x00; 445 | FingerPrint.TxBuffer[12]=0x00; 446 | FingerPrint.TxBuffer[13]=0x01; 447 | FingerPrint.TxBuffer[14]=0xF4; 448 | uint16_t Checksum=0; 449 | for(uint8_t i=0;i<11; i++) 450 | Checksum+=FingerPrint.TxBuffer[i+6]; 451 | FingerPrint.TxBuffer[15]=Checksum>>8; 452 | FingerPrint.TxBuffer[16]=Checksum&0x00FF; 453 | 454 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 455 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,17,100); 456 | for(Timeout=0; Timeout<20 ; Timeout++) 457 | { 458 | osDelay(100); 459 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x07) && (FingerPrint.AnswerBuffer[2]==0x00)) 460 | { 461 | FingerPrint.Lock=0; 462 | if(IfModuleIsOff==1) 463 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 464 | return FingerPrint.AnswerBuffer[3]*256+FingerPrint.AnswerBuffer[4]; 465 | } 466 | if(Timeout>19) 467 | goto Faild; 468 | } 469 | }while(0); 470 | //--- Searching 471 | 472 | Faild: 473 | if(IfModuleIsOff==1) 474 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 475 | FingerPrint.Lock=0; 476 | 477 | return -1; 478 | 479 | 480 | } 481 | //######################################################################################################################### 482 | int16_t FingerPrint_ReadTemplateNumber(void) 483 | { 484 | uint8_t Timeout; 485 | uint8_t IfModuleIsOff=0; 486 | if(FingerPrint.Lock==1) 487 | return -1; 488 | FingerPrint.Lock=1; 489 | FingerPrint.GotAnswer=0; 490 | //+++ Read Template 491 | if(HAL_GPIO_ReadPin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN)==GPIO_PIN_RESET) 492 | IfModuleIsOff=1; 493 | if(IfModuleIsOff==1) 494 | { 495 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 496 | osDelay(500); 497 | } 498 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 499 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 500 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 501 | FingerPrint.TxBuffer[2]=0xFF; 502 | FingerPrint.TxBuffer[3]=0xFF; 503 | FingerPrint.TxBuffer[4]=0xFF; 504 | FingerPrint.TxBuffer[5]=0xFF; 505 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 506 | FingerPrint.TxBuffer[7]=0x00; 507 | FingerPrint.TxBuffer[8]=0x03; 508 | FingerPrint.TxBuffer[9]=FINGERPRINT_TEMPLATECOUNT; 509 | FingerPrint.TxBuffer[10]=0x00; 510 | FingerPrint.TxBuffer[11]=0x21; 511 | do 512 | { 513 | 514 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 515 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 516 | for(Timeout=0; Timeout<20 ; Timeout++) 517 | { 518 | osDelay(100); 519 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x05) && (FingerPrint.AnswerBuffer[2]==0x00)) 520 | { 521 | FingerPrint.Lock=0; 522 | if(IfModuleIsOff==1) 523 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 524 | return FingerPrint.Template=(FingerPrint.AnswerBuffer[3]*256+FingerPrint.AnswerBuffer[4]); 525 | } 526 | } 527 | if(Timeout>19) 528 | goto Faild; 529 | }while(0); 530 | //--- Read Template 531 | 532 | Faild: 533 | if(IfModuleIsOff==1) 534 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 535 | FingerPrint.Lock=0; 536 | return -1; 537 | } 538 | //######################################################################################################################### 539 | //######################################################################################################################### 540 | bool FingerPrint_DeleteAll(void) 541 | { 542 | uint8_t Timeout; 543 | uint8_t IfModuleIsOff=0; 544 | if(FingerPrint.Lock==1) 545 | return -1; 546 | FingerPrint.Lock=1; 547 | FingerPrint.GotAnswer=0; 548 | //+++ Delete All 549 | if(HAL_GPIO_ReadPin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN)==GPIO_PIN_RESET) 550 | IfModuleIsOff=1; 551 | if(IfModuleIsOff==1) 552 | { 553 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 554 | osDelay(500); 555 | } 556 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 557 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 558 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 559 | FingerPrint.TxBuffer[2]=0xFF; 560 | FingerPrint.TxBuffer[3]=0xFF; 561 | FingerPrint.TxBuffer[4]=0xFF; 562 | FingerPrint.TxBuffer[5]=0xFF; 563 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 564 | FingerPrint.TxBuffer[7]=0x00; 565 | FingerPrint.TxBuffer[8]=0x03; 566 | FingerPrint.TxBuffer[9]=FINGERPRINT_EMPTY; 567 | FingerPrint.TxBuffer[10]=0x00; 568 | FingerPrint.TxBuffer[11]=0x11; 569 | do 570 | { 571 | 572 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 573 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 574 | for(Timeout=0; Timeout<20 ; Timeout++) 575 | { 576 | osDelay(100); 577 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 578 | { 579 | FingerPrint.Template=0; 580 | FingerPrint.Lock=0; 581 | if(IfModuleIsOff==1) 582 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 583 | return true; 584 | } 585 | } 586 | if(Timeout>19) 587 | goto Faild; 588 | }while(0); 589 | //--- Delete All 590 | 591 | Faild: 592 | if(IfModuleIsOff==1) 593 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 594 | FingerPrint.Lock=0; 595 | return false; 596 | } 597 | //######################################################################################################################### 598 | bool FingerPrint_DeleteByLocation(uint16_t Location) 599 | { 600 | uint8_t Timeout; 601 | uint8_t IfModuleIsOff=0; 602 | if(FingerPrint.Lock==1) 603 | return -1; 604 | FingerPrint.Lock=1; 605 | FingerPrint.GotAnswer=0; 606 | //+++ Delete 607 | if(HAL_GPIO_ReadPin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN)==GPIO_PIN_RESET) 608 | IfModuleIsOff=1; 609 | if(IfModuleIsOff==1) 610 | { 611 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 612 | osDelay(500); 613 | } 614 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 615 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 616 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 617 | FingerPrint.TxBuffer[2]=0xFF; 618 | FingerPrint.TxBuffer[3]=0xFF; 619 | FingerPrint.TxBuffer[4]=0xFF; 620 | FingerPrint.TxBuffer[5]=0xFF; 621 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 622 | FingerPrint.TxBuffer[7]=0x00; 623 | FingerPrint.TxBuffer[8]=0x07; 624 | FingerPrint.TxBuffer[9]=FINGERPRINT_DELETE; 625 | FingerPrint.TxBuffer[10]=Location>>8; 626 | FingerPrint.TxBuffer[11]=Location&0x00FF; 627 | FingerPrint.TxBuffer[12]=0x00; 628 | FingerPrint.TxBuffer[13]=0x01; 629 | uint16_t Checksum=0; 630 | for(uint8_t i=0;i<8; i++) 631 | Checksum+=FingerPrint.TxBuffer[i+6]; 632 | FingerPrint.TxBuffer[14]=Checksum>>8; 633 | FingerPrint.TxBuffer[15]=Checksum&0x00FF; 634 | do 635 | { 636 | 637 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 638 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,16,100); 639 | for(Timeout=0; Timeout<20 ; Timeout++) 640 | { 641 | osDelay(100); 642 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 643 | { 644 | FingerPrint.Lock=0; 645 | FingerPrint_ReadTemplateNumber(); 646 | if(IfModuleIsOff==1) 647 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 648 | return true; 649 | } 650 | } 651 | if(Timeout>19) 652 | goto Faild; 653 | }while(0); 654 | //--- Delete 655 | 656 | Faild: 657 | if(IfModuleIsOff==1) 658 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 659 | FingerPrint.Lock=0; 660 | return false; 661 | } 662 | //######################################################################################################################### 663 | int16_t FingerPrint_DeleteByFinger(uint8_t TimoutInSecond) 664 | { 665 | uint8_t TimeOut; 666 | uint8_t IfModuleIsOff=0; 667 | int16_t Location=-1; 668 | uint16_t Checksum=0; 669 | if(FingerPrint.Lock==1) 670 | return false; 671 | FingerPrint.Lock=1; 672 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_SET); 673 | osDelay(500); 674 | //+++ take Image 675 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 676 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 677 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 678 | FingerPrint.TxBuffer[2]=0xFF; 679 | FingerPrint.TxBuffer[3]=0xFF; 680 | FingerPrint.TxBuffer[4]=0xFF; 681 | FingerPrint.TxBuffer[5]=0xFF; 682 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 683 | FingerPrint.TxBuffer[7]=0x00; 684 | FingerPrint.TxBuffer[8]=0x03; 685 | FingerPrint.TxBuffer[9]=FINGERPRINT_GETIMAGE; 686 | FingerPrint.TxBuffer[10]=0x00; 687 | FingerPrint.TxBuffer[11]=0x05; 688 | TimeOut=0; 689 | while(TimeOut < TimoutInSecond) 690 | { 691 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 692 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,12,100); 693 | osDelay(1000); 694 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 695 | break; 696 | TimeOut++; 697 | if(TimeOut==TimoutInSecond) 698 | goto Faild; 699 | } 700 | //--- take Image 701 | //+++ put image to buffer 1 702 | do 703 | { 704 | FingerPrint.TxBuffer[8]=0x04; 705 | FingerPrint.TxBuffer[9]=FINGERPRINT_IMAGE2TZ; 706 | FingerPrint.TxBuffer[10]=1; 707 | FingerPrint.TxBuffer[11]=0x00; 708 | FingerPrint.TxBuffer[12]=0x08; 709 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 710 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,13,100); 711 | osDelay(1000); 712 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 713 | break; 714 | else 715 | goto Faild; 716 | }while(0); 717 | //--- put image to buffer 1 718 | 719 | //+++ Wait for put your finger up 720 | TimeOut=0; 721 | while(TimeOut < TimoutInSecond) 722 | { 723 | osDelay(1000); 724 | TimeOut++; 725 | if(TimeOut==TimoutInSecond) 726 | goto Faild; 727 | if( HAL_GPIO_ReadPin(_FINGERPRINT_IRQ_GPIO,_FINGERPRINT_IRQ_PIN)==GPIO_PIN_SET) 728 | break; 729 | } 730 | //--- Wait for put your finger up 731 | 732 | //+++ Searching 733 | do 734 | { 735 | FingerPrint.TxBuffer[8]=0x08; 736 | FingerPrint.TxBuffer[9]=FINGERPRINT_SEARCH; 737 | FingerPrint.TxBuffer[10]=1; 738 | FingerPrint.TxBuffer[11]=0x00; 739 | FingerPrint.TxBuffer[12]=0x00; 740 | FingerPrint.TxBuffer[13]=0x01; 741 | FingerPrint.TxBuffer[14]=0xF4; 742 | for(uint8_t i=0;i<11; i++) 743 | Checksum+=FingerPrint.TxBuffer[i+6]; 744 | FingerPrint.TxBuffer[15]=Checksum>>8; 745 | FingerPrint.TxBuffer[16]=Checksum&0x00FF; 746 | 747 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 748 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,17,100); 749 | for(TimeOut=0; TimeOut<20 ; TimeOut++) 750 | { 751 | osDelay(100); 752 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x07) && (FingerPrint.AnswerBuffer[2]==0x00)) 753 | { 754 | FingerPrint.Lock=0; 755 | if(IfModuleIsOff==1) 756 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 757 | Location = FingerPrint.AnswerBuffer[3]*256+FingerPrint.AnswerBuffer[4]; 758 | break; 759 | } 760 | if(TimeOut>19) 761 | goto Faild; 762 | } 763 | }while(0); 764 | //--- Searching 765 | 766 | //+++ Delete 767 | memset(FingerPrint.TxBuffer,0,sizeof(FingerPrint.TxBuffer)); 768 | FingerPrint.TxBuffer[0]=FINGERPRINT_STARTCODE_BYTE0; 769 | FingerPrint.TxBuffer[1]=FINGERPRINT_STARTCODE_BYTE1; 770 | FingerPrint.TxBuffer[2]=0xFF; 771 | FingerPrint.TxBuffer[3]=0xFF; 772 | FingerPrint.TxBuffer[4]=0xFF; 773 | FingerPrint.TxBuffer[5]=0xFF; 774 | FingerPrint.TxBuffer[6]=FINGERPRINT_COMMANDPACKET; 775 | FingerPrint.TxBuffer[7]=0x00; 776 | FingerPrint.TxBuffer[8]=0x07; 777 | FingerPrint.TxBuffer[9]=FINGERPRINT_DELETE; 778 | FingerPrint.TxBuffer[10]=Location>>8; 779 | FingerPrint.TxBuffer[11]=Location&0x00FF; 780 | FingerPrint.TxBuffer[12]=0x00; 781 | FingerPrint.TxBuffer[13]=0x01; 782 | Checksum=0; 783 | for(uint8_t i=0;i<8; i++) 784 | Checksum+=FingerPrint.TxBuffer[i+6]; 785 | FingerPrint.TxBuffer[14]=Checksum>>8; 786 | FingerPrint.TxBuffer[15]=Checksum&0x00FF; 787 | do 788 | { 789 | 790 | memset(FingerPrint.AnswerBuffer,0,sizeof(FingerPrint.AnswerBuffer)); 791 | HAL_UART_Transmit(&_FINGERPRINT_USART,FingerPrint.TxBuffer,16,100); 792 | for(TimeOut=0; TimeOut<20 ; TimeOut++) 793 | { 794 | osDelay(100); 795 | if((FingerPrint.AnswerBuffer[0]==0x00) && (FingerPrint.AnswerBuffer[1]==0x03) && (FingerPrint.AnswerBuffer[2]==0x00) && (FingerPrint.AnswerBuffer[3]==0x00) && (FingerPrint.AnswerBuffer[4]==0x0A)) 796 | { 797 | FingerPrint.Lock=0; 798 | FingerPrint_ReadTemplateNumber(); 799 | if(IfModuleIsOff==1) 800 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 801 | return Location; 802 | } 803 | } 804 | if(TimeOut>19) 805 | goto Faild; 806 | }while(0); 807 | //--- Delete 808 | 809 | Faild: 810 | if(IfModuleIsOff==1) 811 | HAL_GPIO_WritePin(_FINGERPRINT_POWER_GPIO,_FINGERPRINT_POWER_PIN,GPIO_PIN_RESET); 812 | FingerPrint.Lock=0; 813 | return -1; 814 | 815 | } 816 | //######################################################################################################################### 817 | 818 | -------------------------------------------------------------------------------- /FingerPrint.h: -------------------------------------------------------------------------------- 1 | #ifndef _FINGERPRINT_H_ 2 | #define _FINGERPRINT_H_ 3 | 4 | #include "cmsis_os.h" 5 | #include 6 | #include 7 | //######################################################################################################################### 8 | 9 | 10 | typedef struct 11 | { 12 | uint8_t TxBuffer[32]; 13 | uint8_t RxBuffer[32]; 14 | uint8_t AnswerBuffer[32]; 15 | uint8_t GotAnswer; 16 | uint8_t RxIndex; 17 | uint8_t RxTmp; 18 | uint32_t RxLastTime; 19 | uint8_t TouchIndex; 20 | int16_t LastDetectedLocation; 21 | int16_t Template; 22 | 23 | uint8_t Lock; 24 | 25 | }FingerPrint_t; 26 | 27 | //######################################################################################################################### 28 | void FingerPrint_RxCallback(void); 29 | void FingerPrint_Init(osPriority Priority); 30 | 31 | bool Fingerprint_VerifyPassword(uint32_t pass); 32 | bool Fingerprint_SaveNewFinger(uint16_t Location,uint8_t WaitForFingerInSecond); 33 | int16_t FingerPrint_Scan(void); 34 | int16_t FingerPrint_ReadTemplateNumber(void); 35 | bool FingerPrint_DeleteAll(void); 36 | bool FingerPrint_DeleteByLocation(uint16_t Location); 37 | int16_t FingerPrint_DeleteByFinger(uint8_t TimoutInSecond); 38 | 39 | 40 | // in FingerPrintUser.c Run Automaticaly after detect Saved Finger 41 | void FingerPrint_Detect(uint16_t Location); 42 | //######################################################################################################################### 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | #endif 51 | -------------------------------------------------------------------------------- /FingerPrintConfig.h: -------------------------------------------------------------------------------- 1 | #ifndef _FINGERPRINTCONFIG_H_ 2 | #define _FINGERPRINTCONFIG_H_ 3 | 4 | 5 | #define _FINGERPRINT_USART huart2 6 | #define _FINGERPRINT_POWER_GPIO FINGER_ENABLE_GPIO_Port 7 | #define _FINGERPRINT_POWER_PIN FINGER_ENABLE_Pin 8 | #define _FINGERPRINT_IRQ_GPIO FINGER_IRQ_GPIO_Port 9 | #define _FINGERPRINT_IRQ_PIN FINGER_IRQ_Pin 10 | 11 | 12 | #endif 13 | -------------------------------------------------------------------------------- /FingerPrintUser.c: -------------------------------------------------------------------------------- 1 | 2 | #include "FingerPrint.h" 3 | 4 | 5 | 6 | void FingerPrint_Detect(uint16_t Location) 7 | { 8 | osDelay(10); 9 | } 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FingerPrint R308 library 2 |
3 | I hope use it and enjoy. 4 |
5 | I use Stm32f103vc and Keil Compiler and Stm32CubeMX wizard. 6 |
7 | Please Do This ... 8 |
9 |
10 | 1) Enable FreeRTOS. 11 |
12 | 2) Config your usart and enable RX interrupt on CubeMX. 13 |
14 | 3) Config an input pin and a output pin. 15 |
16 | 4) Select "General peripheral Initalizion as a pair of '.c/.h' file per peripheral" on project settings. 17 |
18 | 5) Config your FingerPrintConfig.h file. 19 |
20 | 6) Add FingerPrint_RxCallBack() on usart interrupt routin. 21 |
22 | 7) call FingerPrint_Init(osPriorityLow) in your any task. 23 |
24 | 8) In R308 module must be first read datasheet. need a digital switch for power. should be connect to output pin and another input pin connect to touch detect pin. 25 | 26 | --------------------------------------------------------------------------------