Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sprilukin committed Jan 15, 2016
1 parent 6ddffef commit a17247c
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,18 +150,19 @@ void loop() {
```

* **void bl999_set_rx_pin(byte pin)** - set up digital pin which will be used to
receive sensor signals. Note: digital pin should support ISR, see datasheet for your microcontroller to find pins which supports interrupts
* **void bl999_rx_start()** - starts listening for message from BL999 sensor(s)
* **void bl999_rx_stop()** - stops listening for the signals
receive sensor signals. Note: digital pin should support ISR,
see datasheet for your microcontroller to find pins which supports interrupts
* **void bl999_rx_start()** - starts listening for messages from BL999 sensor(s)
* **void bl999_rx_stop()** - stops listening for the messages from sensor(s)
* **void bl999_wait_rx()** - blocks execution until message from sensor(s) will be received
* **boolean bl999_wait_rx_max(unsigned long milliseconds)** - blocks execution until message from sensor(s) will be received
but not more than for passed amount of milliseconds. Returns `true` if message has been receieved
`false` otherwise
* **boolean bl999_have_message()** -
returns `true` if message from any sensor was recieved, `false` otherwise
NOTE: message will not be overridden with furrther messages
until it will be read by the client using **bl999_get_message(BL999Info& info)** method
NOTE2: this function does not take in account check sum, so it will return `true` even if message check sum is incorrect
returns `true` if message from any sensor was recieved, `false` otherwise.
**NOTE:** message will not be overridden with furrther messages
until it will be read by the client using **bl999_get_message(BL999Info& info)** method.
**NOTE2:** this function does not take in account check sum, so it will return `true` even if message check sum is incorrect
* **boolean bl999_get_message(BL999Info& info)** -
if message was recieved (matches check sum or not)
it will be written to the passed `info` structure.
Expand Down

0 comments on commit a17247c

Please sign in to comment.