Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of AS3935 by
Diff: AS3935.h
- Revision:
- 4:ab1f1b65468b
- Parent:
- 3:c536a9aa2a1c
- Child:
- 5:28311803e23d
diff -r c536a9aa2a1c -r ab1f1b65468b AS3935.h
--- a/AS3935.h Thu Jun 11 19:45:11 2015 +0000
+++ b/AS3935.h Mon Jun 15 14:27:34 2015 +0000
@@ -70,76 +70,82 @@
//the rest of the register remains intact
void registerWrite(char reg, char mask, char data);
- //read specified register using specified bitmask and return value aligned
- //to lsb, i.e. if value to be read is in a middle of register, function
- //reads register and then aligns lsb of value to lsb of byte
- char registerRead(char reg, char mask);
+ //read specified register using specified bitmask and return value aligned
+ //to lsb, i.e. if value to be read is in a middle of register, function
+ //reads register and then aligns lsb of value to lsb of byte
+ char registerRead(char reg, char mask);
- //reset all the registers on chip to default values
- void reset();
+ //reset all the registers on chip to default values
+ void reset();
- //put chip into power down mode
- void powerDown();
-
- //bring chip out of power down mode and perform RCO calibration
- void powerUp();
+ //set preset defaults
+ void presetDefault();
- //return interrupt source, bitmask, 0b0001 - noise, 0b0100 - disturber,
- //0b1000 - lightning
- int interruptSource();
-
- //disable indication of disturbers
- void disableDisturbers();
-
- //enable indication of distrubers
- void enableDisturbers();
-
- //return number of lightnings that need to be detected in 17 minute period
- //before interrupt is issued
- int getMinimumLightnings();
-
- //set number of lightnings that need to be detected in 17 minute period
- //before interrupt is issued
- int setMinimumLightnings(int minlightning);
+ //initialization
+ void init();
+
+ //put chip into power down mode
+ void powerDown();
+
+ //bring chip out of power down mode and perform RCO calibration
+ void powerUp();
+
+ //return interrupt source, bitmask, 0b0001 - noise, 0b0100 - disturber,
+ //0b1000 - lightning
+ int interruptSource();
- //return distance to lightning in kilometers, 1 means storm is overhead,
- //63 means it is too far to reliably calculate distance
- int lightningDistanceKm();
-
- // load gain preset to operate indoors
- void setIndoors();
+ //disable indication of disturbers
+ void disableDisturbers();
+
+ //enable indication of distrubers
+ void enableDisturbers();
+
+ //return number of lightnings that need to be detected in 17 minute period
+ //before interrupt is issued
+ int getMinimumLightnings();
+
+ //set number of lightnings that need to be detected in 17 minute period
+ //before interrupt is issued
+ int setMinimumLightnings(int minlightning);
+
+ //return distance to lightning in kilometers, 1 means storm is overhead,
+ //63 means it is too far to reliably calculate distance
+ int lightningDistanceKm();
- //load gain preset to operate outdoors
- void setOutdoors();
-
- //return noise floor setting - refer to datasheet for meaning and range
- int getNoiseFloor();
+ // load gain preset to operate indoors
+ void setIndoors();
- //set noise floor setting
- int setNoiseFloor(int noisefloor);
-
- //return spike rejection value - refer to datasheet for meaning and range
- int getSpikeRejection();
+ //load gain preset to operate outdoors
+ void setOutdoors();
- //set spike rejection value
- int setSpikeRejection(int srej);
+ //return noise floor setting - refer to datasheet for meaning and range
+ int getNoiseFloor();
+
+ //set noise floor setting
+ int setNoiseFloor(int noisefloor);
- //return watchdog threshold value - refer to datasheet for meaning and range
- int getWatchdogThreshold();
+ //return spike rejection value - refer to datasheet for meaning and range
+ int getSpikeRejection();
- //set watchdog threshold value
- int setWatchdogThreshold(int wdth);
+ //set spike rejection value
+ int setSpikeRejection(int srej);
- //return tune Capacity value
- int getTuneCap();
+ //return watchdog threshold value - refer to datasheet for meaning and range
+ int getWatchdogThreshold();
+
+ //set watchdog threshold value
+ int setWatchdogThreshold(int wdth);
- //set tune Capacity value
- int setTuneCap(int cap);
+ //return tune Capacity value
+ int getTuneCap();
- //clear internal accumulated lightning statistics
- void clearStats();
+ //set tune Capacity value
+ int setTuneCap(int cap);
+
+ //clear internal accumulated lightning statistics
+ void clearStats();
- int calibrateRCOs (void);
+ int calibrateRCOs (void);
/** Attach a function, lightning interrupt
