Skip to content

Commit 2721dae

Browse files
committed
document updates
1 parent 51be266 commit 2721dae

114 files changed

Lines changed: 1146 additions & 5333 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Doxyfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = "LEDDriver_NXP_Arduino"
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 0.2.0
51+
PROJECT_NUMBER = 0.2.1
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a
@@ -499,25 +499,25 @@ NUM_PROC_THREADS = 1
499499
# normally produced when WARNINGS is set to YES.
500500
# The default value is: NO.
501501

502-
EXTRACT_ALL = YES
502+
EXTRACT_ALL = NO
503503

504504
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
505505
# be included in the documentation.
506506
# The default value is: NO.
507507

508-
EXTRACT_PRIVATE = YES
508+
EXTRACT_PRIVATE = NO
509509

510510
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
511511
# methods of a class will be included in the documentation.
512512
# The default value is: NO.
513513

514-
EXTRACT_PRIV_VIRTUAL = YES
514+
EXTRACT_PRIV_VIRTUAL = NO
515515

516516
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
517517
# scope will be included in the documentation.
518518
# The default value is: NO.
519519

520-
EXTRACT_PACKAGE = YES
520+
EXTRACT_PACKAGE = NO
521521

522522
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
523523
# included in the documentation.

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,21 +75,18 @@ void loop() {
7575
```
7676

7777
# Getting started
78-
For importing library and run the sample code, please find **Getting started** page (README.md) of [TempSensor_NXP_Arduino](https://github.com/teddokano/TempSensor_NXP_Arduino/blob/main/README.md).
79-
<!--
8078
Use **Library manager** in Arduino IDE for easy install
81-
- **Find** this library: **Open** the _**Library Manager**_ pane, **Search** this library and click **INSTALL** button.
82-
![Find the lib](https://github.com/teddokano/additional_files/blob/main/TempSensor_NXP_Arduino/LM_install0s.png)
79+
- **Find** this library: **Open** the _**Library Manager**_ pane, **Search** this library (type "**PCA99**" in the search field then this library will be shown) and click **INSTALL** button.
80+
![Find the lib](https://github.com/teddokano/additional_files/blob/main/LEDDriver_NXP_Arduino/install.png)
8381

8482
- Click **"INSTALL ALL"**
85-
![Install all](https://github.com/teddokano/additional_files/blob/main/TempSensor_NXP_Arduino/LM_install1s.png)
83+
![Install all](https://github.com/teddokano/additional_files/blob/main/LEDDriver_NXP_Arduino/install_all.png)
8684

8785
- Install will be completed quickly
88-
![Install completed](https://github.com/teddokano/additional_files/blob/main/TempSensor_NXP_Arduino/LM_install2s.png)
86+
![Install completed](https://github.com/teddokano/additional_files/blob/main/LEDDriver_NXP_Arduino/install_completed.png)
8987

9088
- Choose a sample code and try!
91-
![Choosing a sample code](https://github.com/teddokano/additional_files/blob/main/TempSensor_NXP_Arduino/LM_install3s.png)
92-
-->
89+
![Choosing a sample code](https://github.com/teddokano/additional_files/blob/main/LEDDriver_NXP_Arduino/using_examples.png)
9390

9491
# What's inside?
9592
## LED driver library
@@ -106,9 +103,11 @@ Method|Role
106103

107104
Example code is provided as scketch files.
108105
### How to use?
109-
For a quick access to those sketch, **refer to last step** of **"Getting started" section** of [TempSensor_NXP_Arduino](https://github.com/teddokano/TempSensor_NXP_Arduino/blob/main/README.md) page (README.md).
106+
For a quick access to those sketch, **refer to last step** of **"Getting started" section** of this page.
110107

111108
### List of sample code
109+
110+
#### Basic examples
112111
Folder|Sketch|Target|Feature
113112
---|---|---|---
114113
PCA9955B/ |0_simple_ch0_PCA9955B |PCA9955B |**Simple** sample for just blinking channel 0
@@ -123,6 +122,10 @@ PCA9957/ |0_simple_ch0_PCA9957 |PCA9957 |**Simple** sample for just blinkin
123122
PCA9957/ |1_all_channels_PCA9957 |PCA9957 |Simple operation to blink **all channels in order**
124123
PCA9957/ |2_color_phases_PCA9957 |PCA9957 |Phase independent dimming on color LEDs: **color mixing**
125124
PCA9957/ |3_direct_register_access_PCA9957 |PCA9957 |**Direct register access** sample. Write/read a register in every 100 mili-second
125+
126+
#### Advanced examples (showing additional features)
127+
Folder|Sketch|Target|Feature
128+
---|---|---|---
126129
concept_examples/ |abstracting_LEDs |PCA9955B |For further easy operations for multiple LEDs
127130
concept_examples/ |buffered_mode |PCA9955B |Demo: how to use "buffered" mode
128131
concept_examples/ |buffered_mode_with_timer |PCA9955B |Demo: LED refresh rate managed by **timer interrupt**. This code is using [MsTimer2](https://playground.arduino.cc/Main/MsTimer2/) library

docs/_l_e_d_driver_8cpp.html

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)