General update to expand on advanced functionality descriptions

Andre Thomas 2018-12-08 17:40:21 +02:00
parent 27016c554b
commit ac96db5fc7
1 changed files with 28 additions and 1 deletions

@ -282,7 +282,9 @@ For example, lets assume you only want the interrupt polling to occur every 500m
sensor29 intpri,10 // interrupt polled every 10*50 milliseconds, approximated
```
### ADVANCED FUNCTION #2 - INTERRUPT DEFFER (INTDEF)
### ADVANCED FUNCTION #2 - INTERRUPT DEFER (INTDEF)
This setting is useful if you need to defer the reporting of an interrupt by event or telemetry until it has occured at least X number of times.
Syntax:
```
@ -290,8 +292,20 @@ sensor29 intdef,pin // Will provide current setting of pin
sensor29 intdef,pin,x // Will set new deffer value to x (0-15)
```
Examples:
```
sensor29 intdef,pin,5 // Will only report interrupt when it occurs 5 times
sensor29 intdef,pin,10 // Will only report interrupt when it has occured 10 times
```
Interrupts occuring a number of times prior to the setting will be counted but ignored for reporting purposes.
### ADVANCED FUNCTION #3 - INTERRUPT TIMER (INTTIMER)
This function is used in conjunction with INTCOUNT (Documented below)
It allows a timer to be configured over which period the number of interrupts will be counted.
Syntax:
```
sensor29 inttimer // Will provide the current amount of seconds for timer
@ -299,11 +313,24 @@ sensor29 inttimer,x // Allows setting number of seconds (x) for timer int
```
### ADVANCED FUNCTION #4 - INTERRUPT COUNTER ENABLE (INTCNT)
Enable interrupt counting for a particular pin. This functionality works in conjunction with INTTIMER (Documented above)
Syntax:
```
sensor29 intcnt,pin // Readback current setting of interrupt counting for pin (0=OFF/1=ON)
sensor29 intcnt,pin,x // Enable/Disable interrupt counting for pin (x=0=OFF,x=1=ON)
```
Use case example could be if you want to count the number of times an interrupt occured on a D0 over a period of 60 seconds. For this we will need the following:
```
sensor29 inttimer,60 // Enable interrupt timer for 60 second interval
sensor29 intcnt,0,1 // Enable interrupt counter for pin D0
```
The above will result in the number of interrupts that occur within the 60 second period configured to be counted and then reported via telemetry at the end of the 60 second time.
A use case for this would be to determine the RPM of something, or perhaps the number of pulses received from an energy meter within a 60 second period to determine energy usage on a per minute bases... or wind speed from impulses received from an anemometer.
### ADVANCED FUNCTION #5 - INTERRUPT RETAIN (INTRETAIN)
This functionality disables immediate even and/or telemetry reporting for a specific pin that has been configured for any of the interrupt modes listed above.