FilesExpand file tree

 master

/

libRFduino.h

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

125 lines (104 loc) · 4.04 KB

 master

/

libRFduino.h

Copy path

Top

File metadata and controls

• Code
• Blame

125 lines (104 loc) · 4.04 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

#ifndef _LIBRFDUINO_H_

#define _LIBRFDUINO_H_

#ifdef __cplusplus

extern "C" {

#endif // __cplusplus

#define MILLISECONDS(x) ((uint64_t)x)

#define SECONDS(x) (x * MILLISECONDS(1000))

#define MINUTES(x) (x * SECONDS(60))

#define HOURS(x) (x * MINUTES(60))

#define DAYS(x) (x * HOURS(24))

#define INFINITE (-1)

#define CELSIUS 0

#define FAHRENHEIT 1

#define LOW 0

#define HIGH 1

#define DISABLE 5

extern int RFduinoBLE_used;

extern int RFduinoGZLL_used;

extern int RFduinoBLE_enabled;

extern int RFduinoGZLL_enabled;

// pass the pin number so you can use the same interrupt handler for all pins

// return 0 to reset wake_detect bit (and not exit RFduino_ULPDelay)

// return 1 to leave wake_detect bit alone (and exit RFduino_ULPDelay)

typedef int (*pin_callback_t)(uint32_t ulPin);

/**

* \brief Ultra low power delay for the amount of time (in milliseconds) specified as parameter.

* You can use the following macros: MILLISECONDS(x), SECONDS(x), MINUTES(x), HOURS(x), DAY(x), INFINITE

* ie: RFduino_ULPDelay( MINUTES(2) + SECONDS(30) )

*

* RFduino_pinWake() can be used to cause HIGH / LOW edges on GPIO pins to exit ulp_delay.

* see documentation for RFduino_pinWake for more details.

*

* \param ms the number of milliseconds to switch to ultra low power (max is DAYS(7) unless INFINITE)

*/

extern void RFduino_ULPDelay( uint64_t ms );

// the same function is used for both BLE and NonBLE (so alias it both ways)

#define RFduinoBLE_ULPDelay(x) RFduino_ULPDelay(x)

/**

* \brief Configures the pin to wake the device from system off.

*

* \param ulPin The number of the digital pin you want to read (int)

* \param dwWake Either DISABLED, HIGH or LOW

*/

extern void RFduino_pinWake( uint32_t ulPin, uint32_t dwWake );

/**

* \brief Test whether a pin caused us to wakeup and exit ulp_delay

*

* \param ulPin The number of the digital pin you want to read (int)

*

* You must call RFduino_resetPinWoke() to reset this condition after processing

*/

extern int RFduino_pinWoke( uint32_t ulPin );

/**

* \brief Reset state of pin that caused us to wakeup and exit ulp_delay

*

* \param ulPin The number of the digital pin you want to reset

*/

extern void RFduino_resetPinWake( uint32_t ulPin );

/**

* \brief Configures the pin to wake the device from system off and execute a callback.

*

* \param ulPin The number of the digital pin you want to read (int)

* \param dwWake Either DISABLED, HIGH or LOW

* \param callback The callback function to execute when the pin is detected.

* Here is an example pin callback function:

* int my_pin_callback(uint32_t pin)

* {

* // do something

* // return 0 to reset wake_detect, return 1 to exit RFduino_ULPDelay

* return 0;

* }

* To call this function on the when pin 5 goes high:

* RFduino_pinWake(5, HIGH, my_pin_callback);

*/

extern void RFduino_pinWakeCallback( uint32_t ulPin, uint32_t dwWake, pin_callback_t callback ) ;

/**

* \brief Reset the system

*/

extern void RFduino_systemReset(void);

/**

* \brief Turn the system off

*/

extern void RFduino_systemOff(void);

/**

* \brief Get a sample from the temperature sensor

*

* \param scale Either CELSIUS or FAHRENHEIT

*

* returns:

* degrees f (-198.00 to +260.00)

* degrees c (-128.00 to +127.00)

*/

extern float RFduino_temperature(int scale);

void rfduino_ppi_channel_assign(uint8_t channel_num, const volatile void * event_endpoint, const volatile void * task_endpoint);

void rfduino_ppi_channel_unassign(uint8_t channel_num);

void rfduino_nvic_enableirq(uint8_t irq_num);

void rfduino_nvic_disableirq(uint8_t irq_num);

void rfduino_nvic_setpriority(uint8_t irq_num, uint32_t priority);

// 1 if the BLE radio is active (or about to become active), 0 if not

extern volatile int RFduinoBLE_radioActive;

#ifdef __cplusplus

}

#endif

#endif