LibDriver SFA30
Loading...
Searching...
No Matches
driver_sfa30.c
Go to the documentation of this file.
1
36
37#include "driver_sfa30.h"
38
42#define CHIP_NAME "Sensirion SFA30"
43#define MANUFACTURER_NAME "Sensirion"
44#define SUPPLY_VOLTAGE_MIN 3.15f
45#define SUPPLY_VOLTAGE_MAX 5.50f
46#define MAX_CURRENT 5.0f
47#define TEMPERATURE_MIN 0.0f
48#define TEMPERATURE_MAX 40.0f
49#define DRIVER_VERSION 1000
50
54#define SFA30_ADDRESS (0x5D << 1)
55
59#define SFA30_IIC_COMMAND_START_MEASUREMENT 0x0006U
60#define SFA30_IIC_COMMAND_STOP_MEASUREMENT 0x0104U
61#define SFA30_IIC_COMMAND_READ_MEASURED_VALUES 0x0327U
62#define SFA30_IIC_COMMAND_READ_DEVICE_INFORMATION 0xD060U
63#define SFA30_IIC_COMMAND_RESET 0xD304U
64#define SFA30_UART_COMMAND_START_MEASUREMENT 0x00
65#define SFA30_UART_COMMAND_STOP_MEASUREMENT 0x01
66#define SFA30_UART_COMMAND_READ_MEASURED_VALUES 0x03
67#define SFA30_UART_COMMAND_READ_DEVICE_INFORMATION 0xD0
68#define SFA30_UART_COMMAND_RESET 0xD3
69
78static uint8_t a_sfa30_generate_crc(sfa30_handle_t *handle, uint8_t* data, uint8_t count)
79{
80 if (handle->iic_uart == SFA30_INTERFACE_IIC)
81 {
82 uint8_t current_byte;
83 uint8_t crc = 0xFF;
84 uint8_t crc_bit;
85
86 for (current_byte = 0; current_byte < count; ++current_byte) /* calculate crc */
87 {
88 crc ^= (data[current_byte]); /* xor data */
89 for (crc_bit = 8; crc_bit > 0; --crc_bit) /* 8 bit */
90 {
91 if ((crc & 0x80) != 0) /* if 7th bit is 1 */
92 {
93 crc = (crc << 1) ^ 0x31; /* xor */
94 }
95 else
96 {
97 crc = crc << 1; /* left shift 1 */
98 }
99 }
100 }
101
102 return crc; /* return crc */
103 }
104 else
105 {
106 uint8_t i;
107 uint32_t crc = 0x00;
108
109 for (i = 0; i < count; i++) /* sum */
110 {
111 crc += data[i]; /* sum */
112 }
113
114 return (uint8_t)(~(crc & 0xFF)); /* take the least significant byte of the result and invert it */
115 }
116}
117
131static uint8_t a_sfa30_iic_read(sfa30_handle_t *handle, uint8_t addr, uint16_t reg, uint8_t *data, uint16_t len, uint16_t delay_ms)
132{
133 uint8_t buf[2];
134
135 buf[0] = (reg >> 8) & 0xFF; /* set msb */
136 buf[1] = (reg >> 0) & 0xFF; /* set lsb */
137 if (handle->iic_write_cmd(addr, (uint8_t *)buf, 2) != 0) /* write data */
138 {
139 return 1; /* return error */
140 }
141 handle->delay_ms(delay_ms); /* delay ms */
142 if (handle->iic_read_cmd(addr, (uint8_t *)data, len) != 0) /* read data */
143 {
144 return 1; /* return error */
145 }
146
147 return 0; /* success return 0 */
148}
149
163static uint8_t a_sfa30_iic_write(sfa30_handle_t *handle, uint8_t addr, uint16_t reg, uint8_t *data, uint16_t len, uint16_t delay_ms)
164{
165 uint8_t buf[16];
166
167 if (len > 14) /* check length */
168 {
169 return 1; /* return error */
170 }
171 buf[0] = (reg >> 8) & 0xFF; /* set msb */
172 buf[1] = (reg >> 0) & 0xFF; /* set lsb */
173 memcpy((uint8_t *)&buf[2], data, len); /* copy data */
174 if (handle->iic_write_cmd(addr, (uint8_t *)buf, len + 2) != 0) /* write data */
175 {
176 return 1; /* return error */
177 }
178 handle->delay_ms(delay_ms); /* delay ms */
179
180 return 0; /* success return 0 */
181}
182
194static uint8_t a_sfa30_uart_get_rx_frame(sfa30_handle_t *handle, uint16_t len, uint8_t *output, uint16_t out_len)
195{
196 uint16_t i, point;
197
198 output[0] = handle->buf[0]; /* set buf[0] */
199 point = 1; /* set point 1 */
200 for (i = 1; i < (len - 1); i++) /* run n -2 times */
201 {
202 if (point >= (out_len - 1)) /* check length */
203 {
204 return 1; /* return error */
205 }
206 if (((handle->buf[i] == 0x7D) && (handle->buf[i + 1]) == 0x5E) || /* check buffer */
207 ((handle->buf[i] == 0x7D) && (handle->buf[i + 1]) == 0x5D) ||
208 ((handle->buf[i] == 0x7D) && (handle->buf[i + 1]) == 0x31) ||
209 ((handle->buf[i] == 0x7D) && (handle->buf[i + 1]) == 0x33)
210 )
211 {
212 switch (handle->buf[i + 1]) /* judge */
213 {
214 case 0x5E : /* 0x5E */
215 {
216 output[point] = 0x7E; /* set output */
217 point++; /* point++ */
218 i++; /* i++ */
219
220 break; /* break */
221 }
222 case 0x5D : /* 0x5D */
223 {
224 output[point] = 0x7D; /* set output */
225 point++; /* point++ */
226 i++; /* i++ */
227
228 break; /* break */
229 }
230 case 0x31 : /* 0x31 */
231 {
232 output[point] = 0x11; /* set output */
233 point++; /* point++ */
234 i++; /* i++ */
235
236 break; /* break */
237 }
238 case 0x33 : /* 0x33 */
239 {
240 output[point] = 0x13; /* set output */
241 point++; /* point++ */
242 i++; /* i++ */
243
244 break; /* break */
245 }
246 default :
247 {
248 break; /* break */
249 }
250 }
251 }
252 else
253 {
254 output[point] = handle->buf[i]; /* set output */
255 point++; /* point++ */
256 }
257 }
258 output[point] = handle->buf[len - 1]; /* set the end part */
259 point++; /* point++ */
260 if (point != out_len) /* check point */
261 {
262 return 1; /* return error */
263 }
264
265 return 0; /* success return 0 */
266}
267
279static uint8_t a_sfa30_uart_set_tx_frame(sfa30_handle_t *handle, uint8_t *input, uint16_t in_len, uint16_t *out_len)
280{
281 uint16_t i;
282
283 memset(handle->buf, 0, sizeof(uint8_t) * 256); /* clear buffer */
284 handle->buf[0] = input[0]; /* set buf[0] */
285 *out_len = 1; /* set output length */
286 for (i = 1; i < (in_len - 1); i++)
287 {
288 if ((*out_len) >= 255) /* check output length */
289 {
290 return 1; /* return error */
291 }
292 if ((input[i] == 0x7E) || (input[i] == 0x7D) || /* check data */
293 (input[i] == 0x11) || (input[i] == 0x13)
294 )
295 {
296 switch (input[i]) /* judge input */
297 {
298 case 0x7E : /* 0x7E */
299 {
300 handle->buf[*out_len] = 0x7D; /* 0x7D */
301 (*out_len)++; /* output length++ */
302 handle->buf[*out_len] = 0x5E; /* 0x5E */
303 (*out_len)++; /* output length++ */
304
305 break; /* break */
306 }
307 case 0x7D : /* 0x7D */
308 {
309 handle->buf[*out_len] = 0x7D; /* set 0x7D */
310 (*out_len)++; /* output length++ */
311 handle->buf[*out_len] = 0x5D; /* set 0x5D */
312 (*out_len)++; /* output length++ */
313
314 break; /* break */
315 }
316 case 0x11 : /* 0x11 */
317 {
318 handle->buf[*out_len] = 0x7D; /* set 0x7D */
319 (*out_len)++; /* output length++ */
320 handle->buf[*out_len] = 0x31; /* set 0x31 */
321 (*out_len)++; /* output length++ */
322
323 break; /* break */
324 }
325 case 0x13 : /* 0x13 */
326 {
327 handle->buf[*out_len] = 0x7D; /* set 0x7D */
328 (*out_len)++; /* output length++ */
329 handle->buf[*out_len] = 0x33; /* set 0x33 */
330 (*out_len)++; /* output length++ */
331
332 break; /* break */
333 }
334 default :
335 {
336 break; /* break */
337 }
338 }
339 }
340 else
341 {
342 handle->buf[*out_len] = input[i]; /* set the buffer */
343 (*out_len)++; /* output length++ */
344 }
345 }
346 handle->buf[*out_len] = input[in_len - 1]; /* copy the end frame */
347 (*out_len)++; /* length++ */
348
349 return 0; /* success return 0 */
350}
351
365static uint8_t a_sfa30_uart_write_read(sfa30_handle_t *handle, uint8_t *input, uint16_t in_len,
366 uint16_t delay_ms, uint8_t *output, uint16_t out_len)
367{
368 uint16_t len;
369
370 if (a_sfa30_uart_set_tx_frame(handle, input, in_len, (uint16_t *)&len) != 0) /* set tx frame */
371 {
372 return 1; /* return error */
373 }
374 if (handle->uart_flush() != 0) /* uart flush */
375 {
376 return 1; /* return error */
377 }
378 if (handle->uart_write(handle->buf, len) != 0) /* write data */
379 {
380 return 1; /* return error */
381 }
382 handle->delay_ms(delay_ms); /* delay ms */
383 len = handle->uart_read(handle->buf, 256); /* read data */
384 if (a_sfa30_uart_get_rx_frame(handle, len, output, out_len) != 0) /* get rx frame */
385 {
386 return 1; /* return error */
387 }
388
389 return 0; /* success return 0 */
390}
391
399static uint8_t a_sfa30_uart_error(sfa30_handle_t *handle, uint8_t e)
400{
401 switch (e)
402 {
403 case 0x00 :
404 {
405 break;
406 }
407 case 0x01 :
408 {
409 handle->debug_print("sfa30: wrong data length for this command error.\n"); /* wrong data length for this command error */
410
411 break;
412 }
413 case 0x02 :
414 {
415 handle->debug_print("sfa30: unknown command.\n"); /* unknown command */
416
417 break;
418 }
419 case 0x03 :
420 {
421 handle->debug_print("sfa30: no access right for command.\n"); /* no access right for command */
422
423 break;
424 }
425 case 0x04 :
426 {
427 handle->debug_print("sfa30: illegal command parameter or parameter "
428 "out of allowed range.\n"); /* illegal command parameter or parameter out of allowed range */
429
430 break;
431 }
432 case 0x20 :
433 {
434 handle->debug_print("sfa30: no measurement data available.\n"); /* no measurement data available */
435
436 break;
437 }
438 case 0x43 :
439 {
440 handle->debug_print("sfa30: command not allowed in current state.\n"); /* command not allowed in current state */
441
442 break;
443 }
444 case 0x44 :
445 {
446 handle->debug_print("sfa30: internal error.\n"); /* internal error */
447
448 break;
449 }
450 case 0x7F :
451 {
452 handle->debug_print("sfa30: general error.\n"); /* general error */
453
454 break;
455 }
456 default :
457 {
458 handle->debug_print("sfa30: unknown code.\n"); /* unknown code */
459
460 break;
461 }
462 }
463
464 return e; /* return error code */
465}
466
476uint8_t sfa30_set_interface(sfa30_handle_t *handle, sfa30_interface_t interface)
477{
478 if (handle == NULL) /* check handle */
479 {
480 return 2; /* return error */
481 }
482
483 handle->iic_uart = (uint8_t)interface; /* set interface */
484
485 return 0; /* success return 0 */
486}
487
497uint8_t sfa30_get_interface(sfa30_handle_t *handle, sfa30_interface_t *interface)
498{
499 if (handle == NULL) /* check handle */
500 {
501 return 2; /* return error */
502 }
503
504 *interface = (sfa30_interface_t)(handle->iic_uart); /* get interface */
505
506 return 0; /* success return 0 */
507}
508
519uint8_t sfa30_start_measurement(sfa30_handle_t *handle)
520{
521 uint8_t res;
522
523 if (handle == NULL) /* check handle */
524 {
525 return 2; /* return error */
526 }
527 if (handle->inited != 1) /* check handle initialization */
528 {
529 return 3; /* return error */
530 }
531
532 if (handle->iic_uart != 0) /* uart */
533 {
534 uint8_t input_buf[6 + 1];
535 uint8_t out_buf[7];
536
537 input_buf[0] = 0x7E; /* set start */
538 input_buf[1] = 0x00; /* set addr */
539 input_buf[2] = SFA30_UART_COMMAND_START_MEASUREMENT; /* set command */
540 input_buf[3] = 0x01; /* set length */
541 input_buf[4] = 0x00; /* set subcommand */
542 input_buf[5] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 4); /* set crc */
543 input_buf[6] = 0x7E; /* set stop */
544 memset(out_buf, 0, sizeof(uint8_t) * 7); /* clear the buffer */
545 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 7, 10, (uint8_t *)out_buf, 7); /* write read frame */
546 if (res != 0) /* check result */
547 {
548 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
549
550 return 1; /* return error */
551 }
552 if (out_buf[5] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
553 {
554 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
555
556 return 1; /* return error */
557 }
558 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
559 {
560 return 1; /* return error */
561 }
562 }
563 else /* iic */
564 {
565 res = a_sfa30_iic_write(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_START_MEASUREMENT, NULL, 0, 1); /* start measurement command */
566 if (res != 0) /* check result */
567 {
568 handle->debug_print("sfa30: start measurement failed.\n"); /* start measurement failed */
569
570 return 1; /* return error */
571 }
572 }
573
574 return 0; /* success return 0 */
575}
576
587uint8_t sfa30_stop_measurement(sfa30_handle_t *handle)
588{
589 uint8_t res;
590
591 if (handle == NULL) /* check handle */
592 {
593 return 2; /* return error */
594 }
595 if (handle->inited != 1) /* check handle initialization */
596 {
597 return 3; /* return error */
598 }
599
600 if (handle->iic_uart != 0) /* uart */
601 {
602 uint8_t input_buf[6 + 0];
603 uint8_t out_buf[7];
604
605 input_buf[0] = 0x7E; /* set start */
606 input_buf[1] = 0x00; /* set addr */
607 input_buf[2] = SFA30_UART_COMMAND_STOP_MEASUREMENT; /* set command */
608 input_buf[3] = 0x00; /* set length */
609 input_buf[4] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 3); /* set crc */
610 input_buf[5] = 0x7E; /* set stop */
611 memset(out_buf, 0, sizeof(uint8_t) * 7); /* clear the buffer */
612 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 6, 10, (uint8_t *)out_buf, 7); /* write read frame */
613 if (res != 0) /* check result */
614 {
615 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
616
617 return 1; /* return error */
618 }
619 if (out_buf[5] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
620 {
621 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
622
623 return 1; /* return error */
624 }
625 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
626 {
627 return 1; /* return error */
628 }
629 }
630 else /* iic */
631 {
632 res = a_sfa30_iic_write(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_STOP_MEASUREMENT, NULL, 0, 50); /* stop measurement command */
633 if (res != 0) /* check result */
634 {
635 handle->debug_print("sfa30: stop measurement failed.\n"); /* stop measurement failed */
636
637 return 1; /* return error */
638 }
639 }
640
641 return 0; /* success return 0 */
642}
643
655uint8_t sfa30_get_device_information(sfa30_handle_t *handle, char info[32])
656{
657 uint8_t res;
658
659 if (handle == NULL) /* check handle */
660 {
661 return 2; /* return error */
662 }
663 if (handle->inited != 1) /* check handle initialization */
664 {
665 return 3; /* return error */
666 }
667
668
669 if (handle->iic_uart != 0) /* uart */
670 {
671 uint8_t input_buf[6 + 1];
672 uint8_t out_buf[7 + 17];
673
674 input_buf[0] = 0x7E; /* set start */
675 input_buf[1] = 0x00; /* set addr */
676 input_buf[2] = SFA30_UART_COMMAND_READ_DEVICE_INFORMATION; /* set command */
677 input_buf[3] = 0x01; /* set length */
678 input_buf[4] = 0x06; /* set subcommand */
679 input_buf[5] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 4); /* set crc */
680 input_buf[6] = 0x7E; /* set stop */
681 memset(info, 0, sizeof(char) * 32); /* clear info */
682 memset(out_buf, 0, sizeof(uint8_t) * 24); /* clear the buffer */
683 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 7, 10, (uint8_t *)out_buf, 24); /* write read frame */
684 if (res != 0) /* check result */
685 {
686 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
687
688 return 1; /* return error */
689 }
690 if (out_buf[21] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 22)) /* check crc */
691 {
692 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
693
694 return 1; /* return error */
695 }
696 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
697 {
698 return 1; /* return error */
699 }
700 memcpy((uint8_t *)info, (uint8_t *)&out_buf[5], 17); /* copy data*/
701 }
702 else /* iic */
703 {
704 uint8_t i;
705 uint8_t buf[48];
706
707 memset(info, 0, sizeof(char) * 32); /* clear info */
708 memset(buf, 0, sizeof(uint8_t) * 48); /* clear the buffer */
709 res = a_sfa30_iic_read(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_READ_DEVICE_INFORMATION, (uint8_t *)buf,
710 48, 2); /* read measured values command */
711 if (res != 0) /* check result */
712 {
713 handle->debug_print("sfa30: read measured values failed.\n"); /* read measured values failed */
714
715 return 1; /* return error */
716 }
717 for (i = 0; i < 16; i++) /* check crc */
718 {
719 if (buf[i * 3 + 2] != a_sfa30_generate_crc(handle, (uint8_t *)&buf[i * 3], 2)) /* check crc */
720 {
721 handle->debug_print("sfa30: crc is error.\n"); /* crc is error */
722
723 return 1; /* return error */
724 }
725 }
726 for (i = 0; i < 16; i++) /* copy info */
727 {
728 info[i * 2 + 0] = (char)buf[i * 3 + 0]; /* copy info */
729 info[i * 2 + 1] = (char)buf[i * 3 + 1]; /* copy info */
730 }
731 }
732
733 return 0; /* success return 0 */
734}
735
746uint8_t sfa30_reset(sfa30_handle_t *handle)
747{
748 uint8_t res;
749
750 if (handle == NULL) /* check handle */
751 {
752 return 2; /* return error */
753 }
754 if (handle->inited != 1) /* check handle initialization */
755 {
756 return 3; /* return error */
757 }
758
759 if (handle->iic_uart != 0) /* uart */
760 {
761 uint8_t input_buf[6];
762 uint8_t out_buf[7];
763
764 input_buf[0] = 0x7E; /* set start */
765 input_buf[1] = 0x00; /* set addr */
766 input_buf[2] = SFA30_UART_COMMAND_RESET; /* set command */
767 input_buf[3] = 0x00; /* set length */
768 input_buf[4] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 3); /* set crc */
769 input_buf[5] = 0x7E; /* set stop */
770 memset(out_buf, 0, sizeof(uint8_t) * 7); /* clear the buffer */
771 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 6, 200, (uint8_t *)out_buf, 7); /* write read frame */
772 if (res != 0) /* check result */
773 {
774 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
775
776 return 1; /* return error */
777 }
778 if (out_buf[5] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
779 {
780 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
781
782 return 1; /* return error */
783 }
784 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
785 {
786 return 1; /* return error */
787 }
788 }
789 else /* iic */
790 {
791 res = a_sfa30_iic_write(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_RESET, NULL, 0, 100); /* reset command */
792 if (res != 0) /* check result */
793 {
794 handle->debug_print("sfa30: reset failed.\n"); /* reset failed */
795
796 return 1; /* return error */
797 }
798 }
799
800 return 0; /* success return 0 */
801}
802
814uint8_t sfa30_read(sfa30_handle_t *handle, sfa30_data_t *data)
815{
816 uint8_t res;
817
818 if ((handle == NULL) || (data == NULL)) /* check handle */
819 {
820 return 2; /* return error */
821 }
822 if (handle->inited != 1) /* check handle initialization */
823 {
824 return 3; /* return error */
825 }
826
827 if (handle->iic_uart != 0) /* uart */
828 {
829 uint8_t input_buf[6 + 1];
830 uint8_t out_buf[7 + 6];
831
832 input_buf[0] = 0x7E; /* set start */
833 input_buf[1] = 0x00; /* set addr */
834 input_buf[2] = SFA30_UART_COMMAND_READ_MEASURED_VALUES; /* set command */
835 input_buf[3] = 0x01; /* set length */
836 input_buf[4] = 0x02; /* set subcommand */
837 input_buf[5] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 4); /* set crc */
838 input_buf[6] = 0x7E; /* set stop */
839 memset(out_buf, 0, sizeof(uint8_t) * 13); /* clear the buffer */
840 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 7, 100, (uint8_t *)out_buf, 13); /* write read frame */
841 if (res != 0) /* check result */
842 {
843 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
844
845 return 1; /* return error */
846 }
847 if (out_buf[11] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 10)) /* check crc */
848 {
849 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
850
851 return 1; /* return error */
852 }
853 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
854 {
855 return 1; /* return error */
856 }
857 data->formaldehyde_raw = (uint16_t)(((uint16_t)(out_buf[5 + 0]) << 8) | ((uint16_t)(out_buf[5 + 1]) << 0)); /* copy formaldehyde */
858 data->humidity_raw = (uint16_t)(((uint16_t)(out_buf[5 + 2]) << 8) | ((uint16_t)(out_buf[5 + 3]) << 0)); /* copy humidity */
859 data->temperature_raw = (uint16_t)(((uint16_t)(out_buf[5 + 4]) << 8) | ((uint16_t)(out_buf[5 + 5]) << 0)); /* copy temperature*/
860 data->formaldehyde = (float)(data->formaldehyde_raw) / 5.0f; /* convert formaldehyde */
861 data->humidity = (float)(data->humidity_raw) / 100.0f; /* convert humidity */
862 data->temperature = (float)(data->temperature_raw) / 200.0f; /* convert temperature*/
863 }
864 else /* iic */
865 {
866 uint8_t i;
867 uint8_t buf[9];
868
869 memset(buf, 0, sizeof(uint8_t) * 9); /* clear the buffer */
870 res = a_sfa30_iic_read(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_READ_MEASURED_VALUES, (uint8_t *)buf, 9, 5); /* read measured values command */
871 if (res != 0) /* check result */
872 {
873 handle->debug_print("sfa30: read measured values failed.\n"); /* read measured values failed */
874
875 return 1; /* return error */
876 }
877 for (i = 0; i < 3; i++) /* check crc */
878 {
879 if (buf[i * 3 + 2] != a_sfa30_generate_crc(handle, (uint8_t *)&buf[i * 3], 2)) /* check crc */
880 {
881 handle->debug_print("sfa30: crc is error.\n"); /* crc is error */
882
883 return 1; /* return error */
884 }
885 }
886 data->formaldehyde_raw = (uint16_t)(((uint16_t)(buf[0]) << 8) | ((uint16_t)(buf[1]) << 0)); /* copy formaldehyde */
887 data->humidity_raw = (uint16_t)(((uint16_t)(buf[3]) << 8) | ((uint16_t)(buf[4]) << 0)); /* copy humidity */
888 data->temperature_raw = (uint16_t)(((uint16_t)(buf[6]) << 8) | ((uint16_t)(buf[7]) << 0)); /* copy temperature*/
889 data->formaldehyde = (float)(data->formaldehyde_raw) / 5.0f; /* convert formaldehyde */
890 data->humidity = (float)(data->humidity_raw) / 100.0f; /* convert humidity */
891 data->temperature = (float)(data->temperature_raw) / 200.0f; /* convert temperature*/
892 }
893
894 return 0; /* success return 0 */
895}
896
908uint8_t sfa30_init(sfa30_handle_t *handle)
909{
910 uint8_t res;
911
912 if (handle == NULL) /* check handle */
913 {
914 return 2; /* return error */
915 }
916 if (handle->debug_print == NULL) /* check debug_print */
917 {
918 return 3; /* return error */
919 }
920 if (handle->iic_init == NULL) /* check iic_init */
921 {
922 handle->debug_print("sfa30: iic_init is null.\n"); /* iic_init is null */
923
924 return 3; /* return error */
925 }
926 if (handle->iic_deinit == NULL) /* check iic_deinit */
927 {
928 handle->debug_print("sfa30: iic_deinit is null.\n"); /* iic_deinit is null */
929
930 return 3; /* return error */
931 }
932 if (handle->iic_write_cmd == NULL) /* check iic_write_cmd */
933 {
934 handle->debug_print("sfa30: iic_write_cmd is null.\n"); /* iic_write_cmd is null */
935
936 return 3; /* return error */
937 }
938 if (handle->iic_read_cmd == NULL) /* check iic_read_cmd */
939 {
940 handle->debug_print("sfa30: iic_read_cmd is null.\n"); /* iic_read_cmd is null */
941
942 return 3; /* return error */
943 }
944 if (handle->uart_init == NULL) /* check uart_init */
945 {
946 handle->debug_print("sfa30: uart_init is null.\n"); /* uart_init is null */
947
948 return 3; /* return error */
949 }
950 if (handle->uart_deinit == NULL) /* check uart_deinit */
951 {
952 handle->debug_print("sfa30: uart_deinit is null.\n"); /* uart_deinit is null */
953
954 return 3; /* return error */
955 }
956 if (handle->uart_read == NULL) /* check uart_read */
957 {
958 handle->debug_print("sfa30: uart_read is null.\n"); /* uart_read is null */
959
960 return 3; /* return error */
961 }
962 if (handle->uart_write == NULL) /* check uart_write */
963 {
964 handle->debug_print("sfa30: uart_write is null.\n"); /* uart_write is null */
965
966 return 3; /* return error */
967 }
968 if (handle->uart_flush == NULL) /* check uart_flush */
969 {
970 handle->debug_print("sfa30: uart_flush is null.\n"); /* uart_flush is null */
971
972 return 3; /* return error */
973 }
974 if (handle->delay_ms == NULL) /* check delay_ms */
975 {
976 handle->debug_print("sfa30: delay_ms is null.\n"); /* delay_ms is null */
977
978 return 3; /* return error */
979 }
980
981 if (handle->iic_uart != 0) /* uart */
982 {
983 uint8_t input_buf[6];
984 uint8_t out_buf[7];
985
986 if (handle->uart_init() != 0) /* uart init */
987 {
988 handle->debug_print("sfa30: uart init failed.\n"); /* uart init failed */
989
990 return 3; /* return error */
991 }
992 input_buf[0] = 0x7E; /* set start */
993 input_buf[1] = 0x00; /* set addr */
994 input_buf[2] = SFA30_UART_COMMAND_RESET; /* set command */
995 input_buf[3] = 0x00; /* set length */
996 input_buf[4] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 3); /* set crc */
997 input_buf[5] = 0x7E; /* set stop */
998 memset(out_buf, 0, sizeof(uint8_t) * 7); /* clear the buffer */
999 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 6, 100, (uint8_t *)out_buf, 7); /* write read frame */
1000 if (res != 0) /* check result */
1001 {
1002 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
1003 (void)handle->uart_deinit(); /* uart deinit */
1004
1005 return 1; /* return error */
1006 }
1007 if (out_buf[5] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
1008 {
1009 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
1010 (void)handle->uart_deinit(); /* uart deinit */
1011
1012 return 1; /* return error */
1013 }
1014 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
1015 {
1016 (void)handle->uart_deinit(); /* uart deinit */
1017
1018 return 1; /* return error */
1019 }
1020 }
1021 else /* iic */
1022 {
1023 if (handle->iic_init() != 0) /* iic init */
1024 {
1025 handle->debug_print("sfa30: iic init failed.\n"); /* iic init failed */
1026
1027 return 3; /* return error */
1028 }
1029 res = a_sfa30_iic_write(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_RESET, NULL, 0, 100); /* reset command */
1030 if (res != 0) /* check result */
1031 {
1032 handle->debug_print("sfa30: reset failed.\n"); /* reset failed */
1033 (void)handle->iic_deinit(); /* iic deinit */
1034
1035 return 4; /* return error */
1036 }
1037 }
1038 handle->inited = 1; /* flag finish initialization */
1039
1040 return 0; /* success return 0 */
1041}
1042
1054uint8_t sfa30_deinit(sfa30_handle_t *handle)
1055{
1056 uint8_t res;
1057
1058 if (handle == NULL) /* check handle */
1059 {
1060 return 2; /* return error */
1061 }
1062 if (handle->inited != 1) /* check handle initialization */
1063 {
1064 return 3; /* return error */
1065 }
1066
1067 if (handle->iic_uart != 0) /* uart */
1068 {
1069 uint8_t input_buf[6];
1070 uint8_t out_buf[7];
1071
1072 input_buf[0] = 0x7E; /* set start */
1073 input_buf[1] = 0x00; /* set addr */
1074 input_buf[2] = SFA30_UART_COMMAND_RESET; /* set command */
1075 input_buf[3] = 0x00; /* set length */
1076 input_buf[4] = a_sfa30_generate_crc(handle, (uint8_t *)&input_buf[1], 3); /* set crc */
1077 input_buf[5] = 0x7E; /* set stop */
1078 memset(out_buf, 0, sizeof(uint8_t) * 7); /* clear the buffer */
1079 res = a_sfa30_uart_write_read(handle, (uint8_t *)input_buf, 6, 100, (uint8_t *)out_buf, 7); /* write read frame */
1080 if (res != 0) /* check result */
1081 {
1082 handle->debug_print("sfa30: write read failed.\n"); /* write read failed */
1083
1084 return 4; /* return error */
1085 }
1086 if (out_buf[5] != a_sfa30_generate_crc(handle, (uint8_t *)&out_buf[1], 4)) /* check crc */
1087 {
1088 handle->debug_print("sfa30: crc check error.\n"); /* crc check error */
1089
1090 return 4; /* return error */
1091 }
1092 if (a_sfa30_uart_error(handle, out_buf[3]) != 0) /* check status */
1093 {
1094 return 4; /* return error */
1095 }
1096 if (handle->uart_deinit() != 0) /* uart deinit */
1097 {
1098 handle->debug_print("sfa30: uart deinit failed.\n"); /* uart deinit failed */
1099
1100 return 1; /* return error */
1101 }
1102 }
1103 else /* iic */
1104 {
1105 res = a_sfa30_iic_write(handle, SFA30_ADDRESS, SFA30_IIC_COMMAND_RESET, NULL, 0, 100); /* reset command */
1106 if (res != 0) /* check result */
1107 {
1108 handle->debug_print("sfa30: reset failed.\n"); /* reset failed */
1109
1110 return 4; /* return error */
1111 }
1112 res = handle->iic_deinit(); /* iic deinit */
1113 if (res != 0) /* check result */
1114 {
1115 handle->debug_print("sfa30: iic deinit failed.\n"); /* iic deinit */
1116
1117 return 1; /* return error */
1118 }
1119 }
1120
1121 handle->inited = 0; /* flag close initialization */
1122
1123 return 0; /* success return 0 */
1124}
1125
1138uint8_t sfa30_set_get_reg_uart(sfa30_handle_t *handle, uint8_t *input, uint16_t in_len, uint8_t *output, uint16_t out_len)
1139{
1140 if (handle == NULL) /* check handle */
1141 {
1142 return 2; /* return error */
1143 }
1144 if (handle->inited != 1) /* check handle initialization */
1145 {
1146 return 3; /* return error */
1147 }
1148
1149 if (handle->iic_uart != 0)
1150 {
1151 return a_sfa30_uart_write_read(handle, input, in_len, 20, output, out_len); /* write and read with the uart interface */
1152 }
1153 else
1154 {
1155 handle->debug_print("sfa30: iic interface is invalid.\n"); /* iic interface is invalid */
1156
1157 return 1; /* return error */
1158 }
1159}
1160
1174uint8_t sfa30_set_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
1175{
1176 if (handle == NULL) /* check handle */
1177 {
1178 return 2; /* return error */
1179 }
1180 if (handle->inited != 1) /* check handle initialization */
1181 {
1182 return 3; /* return error */
1183 }
1184
1185 if (handle->iic_uart != 0)
1186 {
1187 handle->debug_print("sfa30: uart interface is invalid.\n"); /* uart interface is invalid */
1188
1189 return 1; /* return error */
1190 }
1191 else
1192 {
1193 return a_sfa30_iic_write(handle, SFA30_ADDRESS, reg, buf, len, 20); /* write the data */
1194 }
1195}
1196
1210uint8_t sfa30_get_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
1211{
1212 if (handle == NULL) /* check handle */
1213 {
1214 return 2; /* return error */
1215 }
1216 if (handle->inited != 1) /* check handle initialization */
1217 {
1218 return 3; /* return error */
1219 }
1220
1221 if (handle->iic_uart != 0)
1222 {
1223 handle->debug_print("sfa30: uart interface is invalid.\n"); /* uart interface is invalid */
1224
1225 return 1;
1226 }
1227 else
1228 {
1229 return a_sfa30_iic_read(handle, SFA30_ADDRESS, reg, buf, len, 20); /* read the data */
1230 }
1231}
1232
1241uint8_t sfa30_info(sfa30_info_t *info)
1242{
1243 if (info == NULL) /* check handle */
1244 {
1245 return 2; /* return error */
1246 }
1247
1248 memset(info, 0, sizeof(sfa30_info_t)); /* initialize sfa30 info structure */
1249 strncpy(info->chip_name, CHIP_NAME, 32); /* copy chip name */
1250 strncpy(info->manufacturer_name, MANUFACTURER_NAME, 32); /* copy manufacturer name */
1251 strncpy(info->interface, "UART IIC", 16); /* copy interface name */
1252 info->supply_voltage_min_v = SUPPLY_VOLTAGE_MIN; /* set minimal supply voltage */
1253 info->supply_voltage_max_v = SUPPLY_VOLTAGE_MAX; /* set maximum supply voltage */
1254 info->max_current_ma = MAX_CURRENT; /* set maximum current */
1255 info->temperature_max = TEMPERATURE_MAX; /* set minimal temperature */
1256 info->temperature_min = TEMPERATURE_MIN; /* set maximum temperature */
1257 info->driver_version = DRIVER_VERSION; /* set driver version */
1258
1259 return 0; /* success return 0 */
1260}
SFA30_UART_COMMAND_RESET
#define SFA30_UART_COMMAND_RESET
Definition driver_sfa30.c:68
SFA30_UART_COMMAND_START_MEASUREMENT
#define SFA30_UART_COMMAND_START_MEASUREMENT
Definition driver_sfa30.c:64
SFA30_UART_COMMAND_READ_MEASURED_VALUES
#define SFA30_UART_COMMAND_READ_MEASURED_VALUES
Definition driver_sfa30.c:66
MAX_CURRENT
#define MAX_CURRENT
Definition driver_sfa30.c:46
SFA30_UART_COMMAND_STOP_MEASUREMENT
#define SFA30_UART_COMMAND_STOP_MEASUREMENT
Definition driver_sfa30.c:65
SFA30_IIC_COMMAND_READ_DEVICE_INFORMATION
#define SFA30_IIC_COMMAND_READ_DEVICE_INFORMATION
Definition driver_sfa30.c:62
SFA30_UART_COMMAND_READ_DEVICE_INFORMATION
#define SFA30_UART_COMMAND_READ_DEVICE_INFORMATION
Definition driver_sfa30.c:67
SFA30_IIC_COMMAND_STOP_MEASUREMENT
#define SFA30_IIC_COMMAND_STOP_MEASUREMENT
Definition driver_sfa30.c:60
SUPPLY_VOLTAGE_MAX
#define SUPPLY_VOLTAGE_MAX
Definition driver_sfa30.c:45
SFA30_IIC_COMMAND_RESET
#define SFA30_IIC_COMMAND_RESET
Definition driver_sfa30.c:63
TEMPERATURE_MAX
#define TEMPERATURE_MAX
Definition driver_sfa30.c:48
MANUFACTURER_NAME
#define MANUFACTURER_NAME
Definition driver_sfa30.c:43
TEMPERATURE_MIN
#define TEMPERATURE_MIN
Definition driver_sfa30.c:47
SUPPLY_VOLTAGE_MIN
#define SUPPLY_VOLTAGE_MIN
Definition driver_sfa30.c:44
CHIP_NAME
#define CHIP_NAME
chip information definition
Definition driver_sfa30.c:42
SFA30_ADDRESS
#define SFA30_ADDRESS
chip address definition
Definition driver_sfa30.c:54
DRIVER_VERSION
#define DRIVER_VERSION
Definition driver_sfa30.c:49
SFA30_IIC_COMMAND_READ_MEASURED_VALUES
#define SFA30_IIC_COMMAND_READ_MEASURED_VALUES
Definition driver_sfa30.c:61
SFA30_IIC_COMMAND_START_MEASUREMENT
#define SFA30_IIC_COMMAND_START_MEASUREMENT
chip command definition
Definition driver_sfa30.c:59
driver_sfa30.h
driver sfa30 header file
sfa30_info
uint8_t sfa30_info(sfa30_info_t *info)
get chip information
Definition driver_sfa30.c:1241
sfa30_interface_t
sfa30_interface_t
sfa30 interface enumeration definition
Definition driver_sfa30.h:63
sfa30_handle_t
struct sfa30_handle_s sfa30_handle_t
sfa30 handle structure definition
sfa30_set_interface
uint8_t sfa30_set_interface(sfa30_handle_t *handle, sfa30_interface_t interface)
set the chip interface
Definition driver_sfa30.c:476
sfa30_init
uint8_t sfa30_init(sfa30_handle_t *handle)
initialize the chip
Definition driver_sfa30.c:908
sfa30_get_interface
uint8_t sfa30_get_interface(sfa30_handle_t *handle, sfa30_interface_t *interface)
get the chip interface
Definition driver_sfa30.c:497
sfa30_deinit
uint8_t sfa30_deinit(sfa30_handle_t *handle)
close the chip
Definition driver_sfa30.c:1054
sfa30_get_device_information
uint8_t sfa30_get_device_information(sfa30_handle_t *handle, char info[32])
get device information
Definition driver_sfa30.c:655
sfa30_reset
uint8_t sfa30_reset(sfa30_handle_t *handle)
reset the chip
Definition driver_sfa30.c:746
sfa30_read
uint8_t sfa30_read(sfa30_handle_t *handle, sfa30_data_t *data)
read the result
Definition driver_sfa30.c:814
sfa30_data_t
struct sfa30_data_s sfa30_data_t
sfa30 data structure definition
sfa30_stop_measurement
uint8_t sfa30_stop_measurement(sfa30_handle_t *handle)
stop the measurement
Definition driver_sfa30.c:587
sfa30_start_measurement
uint8_t sfa30_start_measurement(sfa30_handle_t *handle)
start the measurement
Definition driver_sfa30.c:519
sfa30_info_t
struct sfa30_info_s sfa30_info_t
sfa30 information structure definition
SFA30_INTERFACE_IIC
@ SFA30_INTERFACE_IIC
Definition driver_sfa30.h:64
sfa30_get_reg_iic
uint8_t sfa30_get_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
get the chip register with iic interface
Definition driver_sfa30.c:1210
sfa30_set_reg_iic
uint8_t sfa30_set_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len)
set the chip register with iic interface
Definition driver_sfa30.c:1174
sfa30_set_get_reg_uart
uint8_t sfa30_set_get_reg_uart(sfa30_handle_t *handle, uint8_t *input, uint16_t in_len, uint8_t *output, uint16_t out_len)
set and get the chip register with uart interface
Definition driver_sfa30.c:1138
sfa30_data_s::formaldehyde_raw
int16_t formaldehyde_raw
Definition driver_sfa30.h:73
sfa30_data_s::humidity
float humidity
Definition driver_sfa30.h:77
sfa30_data_s::temperature_raw
int16_t temperature_raw
Definition driver_sfa30.h:75
sfa30_data_s::humidity_raw
int16_t humidity_raw
Definition driver_sfa30.h:74
sfa30_data_s::formaldehyde
float formaldehyde
Definition driver_sfa30.h:76
sfa30_data_s::temperature
float temperature
Definition driver_sfa30.h:78
sfa30_handle_s::iic_uart
uint8_t iic_uart
Definition driver_sfa30.h:98
sfa30_handle_s::uart_flush
uint8_t(* uart_flush)(void)
Definition driver_sfa30.h:93
sfa30_handle_s::inited
uint8_t inited
Definition driver_sfa30.h:97
sfa30_handle_s::buf
uint8_t buf[256]
Definition driver_sfa30.h:99
sfa30_handle_s::uart_write
uint8_t(* uart_write)(uint8_t *buf, uint16_t len)
Definition driver_sfa30.h:94
sfa30_handle_s::delay_ms
void(* delay_ms)(uint32_t ms)
Definition driver_sfa30.h:95
sfa30_handle_s::uart_deinit
uint8_t(* uart_deinit)(void)
Definition driver_sfa30.h:91
sfa30_handle_s::debug_print
void(* debug_print)(const char *const fmt,...)
Definition driver_sfa30.h:96
sfa30_handle_s::iic_init
uint8_t(* iic_init)(void)
Definition driver_sfa30.h:86
sfa30_handle_s::uart_read
uint16_t(* uart_read)(uint8_t *buf, uint16_t len)
Definition driver_sfa30.h:92
sfa30_handle_s::iic_read_cmd
uint8_t(* iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len)
Definition driver_sfa30.h:89
sfa30_handle_s::uart_init
uint8_t(* uart_init)(void)
Definition driver_sfa30.h:90
sfa30_handle_s::iic_deinit
uint8_t(* iic_deinit)(void)
Definition driver_sfa30.h:87
sfa30_handle_s::iic_write_cmd
uint8_t(* iic_write_cmd)(uint8_t addr, uint8_t *buf, uint16_t len)
Definition driver_sfa30.h:88
sfa30_info_s::temperature_max
float temperature_max
Definition driver_sfa30.h:114
sfa30_info_s::supply_voltage_max_v
float supply_voltage_max_v
Definition driver_sfa30.h:111
sfa30_info_s::driver_version
uint32_t driver_version
Definition driver_sfa30.h:115
sfa30_info_s::interface
char interface[16]
Definition driver_sfa30.h:109
sfa30_info_s::temperature_min
float temperature_min
Definition driver_sfa30.h:113
sfa30_info_s::max_current_ma
float max_current_ma
Definition driver_sfa30.h:112
sfa30_info_s::manufacturer_name
char manufacturer_name[32]
Definition driver_sfa30.h:108
sfa30_info_s::supply_voltage_min_v
float supply_voltage_min_v
Definition driver_sfa30.h:110
sfa30_info_s::chip_name
char chip_name[32]
Definition driver_sfa30.h:107