Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abrauchli committed Jun 27, 2018
1 parent 9f0f168 commit c45ebaf
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,37 @@ SHT product line.
```

## Repository content
* embedded-common (submodule repository for common embedded driver stuff)
* sht-common (SHTxx related)
* embedded-common (submodule repository for the common embedded driver HAL)
* sht-common (common files for all SHTxx drivers)
* sht3x (SHT3x driver related)
* shtc1 (SHTC1/SHTW1/SHTW2 driver related)
* shtc1 (SHTC3/SHTC1/SHTW1/SHTW2 driver related)

## Collecting resources
```
make release
```
This will create a release folder
with the necessary driver files in it, including a Makefile. That way, you have
just ONE folder with all the sources ready to build your driver for your
platform.
This will create the `release` folder with the necessary driver files in it,
including a Makefile. That way, you have just ONE folder with all the sources
ready to build your driver for your platform.

## Files to adjust (from embedded-common)
You only need to touch the following files:

* `sensirion_arch_config.h` (architecture specifics, you need to specify
the integer sizes)

and depending on your i2c implementation one of the following:
and depending on your i2c implementation either of the following:

* `sensirion_hw_i2c_implementation.c` (functions for hardware i2c
communication if your platform supports that)
* `sensirion_sw_i2c_implementation.c` (functions for software i2c
communication via GPIOs)
* `embedded-common/hw_i2c/sensirion_hw_i2c_implementation.c`
functions for hardware i2c communication if your platform supports that
* `embedded-common/sw_i2c/sensirion_sw_i2c_implementation.c`
functions for software i2c communication via GPIOs

## Building the driver
1. Adjust sensirion\_arch\_config.h if you don't have the `<stdint.h>` header
file available
2. Implement necessary functions in one of the `*_implementation.c` files
described above
3. make

---
Expand Down

0 comments on commit c45ebaf

Please sign in to comment.