Skip to content

Commit

Permalink
Update README.md with simulator details
Browse files Browse the repository at this point in the history
  • Loading branch information
hayschan authored Dec 27, 2023
1 parent 1e53070 commit ce472c6
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,19 @@ See [XGZF4000 online datasheet](https://cfsensor.com/wp-content/uploads/2022/11/

In addition to the online version of the XGZF4000 Air Flow Sensor datasheet, an [archived copy](/docs/XGZF4000-Air-Flow-Sensor-V2.2.pdf) is also available within the repository. This archived version can be found at the location `./docs/XGZF4000-Air-Flow-Sensor-V2.2.pdf`. This ensures that users have access to the datasheet even in offline scenarios or if the online version becomes unavailable.

## Operation modes
## Using the driver

### Operation modes
New data from XGZF4000 can be obtained in Polling modes.

> Note: The user is responsible for initialization and configuration of I2C bus.
### Polling mode
After calling `xgzf4000_new_sensor()`, the user is responsible for periodically reading the air flow data from XGZF4000.
After calling `xgzf4000_new_sensor()`, the user is responsible for periodically reading the air flow data from XGZF4000.

## Simulator

To simulate this project, install [Wokwi for VS Code](https://marketplace.visualstudio.com/items?itemName=wokwi.wokwi-vscode). Open the project (at `./simulation`) directory in Visual Studio Code, press **F1** and select "Wokwi: Start Simulator".

> Please note that Wokwi for VS Code is a commercial product and requires a license after a free trial period.
You may also use the online Wokwi simulator with [this sample project](https://wokwi.com/projects/385249858064235521).

0 comments on commit ce472c6

Please sign in to comment.