Skip to content

Commit

Permalink
This is RUIv3 SDK inside 3.0.0-p1_final.42 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
eddieho1124 committed Oct 29, 2021
1 parent 1ccac19 commit 5430cc3
Show file tree
Hide file tree
Showing 229 changed files with 2,426 additions and 1,986 deletions.
401 changes: 0 additions & 401 deletions CHANGELOG.md

This file was deleted.

53 changes: 0 additions & 53 deletions README.md

This file was deleted.

2 changes: 1 addition & 1 deletion cores/nRF5/component/core/board/rak4631/sdk_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -11722,7 +11722,7 @@

// <o> NRF_SDH_BLE_GATT_MAX_MTU_SIZE - Static maximum MTU size.
#ifndef NRF_SDH_BLE_GATT_MAX_MTU_SIZE
#define NRF_SDH_BLE_GATT_MAX_MTU_SIZE 67 //23 //247
#define NRF_SDH_BLE_GATT_MAX_MTU_SIZE 247
#endif

#ifdef DFU_SUPPORT
Expand Down
Binary file modified cores/nRF5/component/core/soc/nrf52840/libboot.a
Binary file not shown.
Binary file modified cores/nRF5/component/core/soc/nrf52840/uhal/libuhal.a
Binary file not shown.
52 changes: 39 additions & 13 deletions cores/nRF5/component/rui_v3_api/ACharacter.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
* @par Syntax
* isAlphaNumeric(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is alphanumeric(Type: bool)
* @return bool
* @retval TRUE : The character is alphanumeric
* @retval FALSE : The character is not alphanumeric
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -47,7 +49,9 @@ inline boolean isAlphaNumeric(int thisChar) __attribute__((always_inline));
* @par Syntax
* isAlpha(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is alpha(Type: bool)
* @return bool
* @retval TRUE : The character is a letter
* @retval FALSE : The character is not a letter
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -74,7 +78,9 @@ inline boolean isAlpha(int thisChar) __attribute__((always_inline));
* @par Syntax
* isAscii(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is Ascii(Type: bool)
* @return bool
* @retval TRUE : The character is Ascii
* @retval FALSE : The character is not Ascii
* @par Example
* @verbatim
char mychar = 'A';
Expand Down Expand Up @@ -102,7 +108,9 @@ inline boolean isAscii(int thisChar) __attribute__((always_inline));
* @par Syntax
* isWhitespace(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is a space character(Type: bool)
* @return bool
* @retval TRUE : The character is a space or tab
* @retval FALSE : The character is not a space or tab
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -129,7 +137,9 @@ inline boolean isWhitespace(int thisChar) __attribute__((always_inline));
* @par Syntax
* isControl(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is a control character(Type: bool)
* @return bool
* @retval TRUE : The character is a control character
* @retval FALSE : The character is not a control character
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -156,7 +166,9 @@ inline boolean isControl(int thisChar) __attribute__((always_inline));
* @par Syntax
* isDigit(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is a number(Type: bool)
* @return bool
* @retval TRUE : The character is a number
* @retval FALSE : The character is not a number
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -183,7 +195,9 @@ inline boolean isDigit(int thisChar) __attribute__((always_inline));
* @par Syntax
* isGraph(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is printable(Type: bool)
* @return bool
* @retval TRUE : The character is printable
* @retval FALSE : The character is not printable
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -210,7 +224,9 @@ inline boolean isGraph(int thisChar) __attribute__((always_inline));
* @par Syntax
* isLowerCase(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is lower case(Type: bool)
* @return bool
* @retval TRUE : The character is lower case
* @retval FALSE : The character is not lower case
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -237,7 +253,9 @@ inline boolean isLowerCase(int thisChar) __attribute__((always_inline));
* @par Syntax
* isPrintAble(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is printable(Type: bool)
* @return bool
* @retval TRUE : The character is printable
* @retval FALSE : The character is not printable
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -264,7 +282,9 @@ inline boolean isPrintable(int thisChar) __attribute__((always_inline));
* @par Syntax
* isPunct(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is punctuation(Type: bool)
* @return bool
* @retval TRUE : The character is a punctuation
* @retval FALSE : The character is not a punctuation
* @par Example
* @verbatim
char mychar = 'A';
Expand Down Expand Up @@ -292,7 +312,9 @@ inline boolean isPunct(int thisChar) __attribute__((always_inline));
* @par Syntax
* isSpace(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is a white-space character(Type: bool)
* @return bool
* @retval TRUE : The character is white-space
* @retval FALSE : The character is not white-space
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -319,7 +341,9 @@ inline boolean isSpace(int thisChar) __attribute__((always_inline));
* @par Syntax
* isUpperCase(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is upper case(Type: bool)
* @return bool
* @retval TRUE : The character is upper case
* @retval FALSE : The character is not upper case
* @par Example
* @verbatim
char mychar = 'A';
Expand All @@ -346,7 +370,9 @@ inline boolean isUpperCase(int thisChar) __attribute__((always_inline));
* @par Syntax
* isHexadecimalDigit(thisChar);
* @param thisChar variable(Type: char)
* @return true: if thisChar is an hexdecimal digit(Type: bool)
* @return bool
* @retval TRUE : The character is an hexadecimal digit
* @retval FALSE : The character is not an hexadecimal digit
* @par Example
* @verbatim
char mychar = 'A';
Expand Down
8 changes: 5 additions & 3 deletions cores/nRF5/component/rui_v3_api/HardwareSerial.h
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class HardwareSerial : public Stream
}

void begin(uint32_t baud, uint8_t config, UART_MODE mode = AT_MODE);
int32_t password(string new_passwd);
bool password(string new_passwd);
size_t write(uint8_t n) {return write(&n, 1);}

/**@addtogroup Serial
Expand Down Expand Up @@ -157,7 +157,9 @@ class HardwareSerial : public Stream
* @param new_passwd an char array to set for unlock the device
* @param len the length your password set
*
* @return SERIAL_WLOCK_STATE
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
* @par Example
* @verbatim
void setup() {
Expand All @@ -173,7 +175,7 @@ class HardwareSerial : public Stream
}
@endverbatim
*/
int32_t password(char *new_passwd, size_t len);
bool password(char *new_passwd, size_t len);


/**@par Description
Expand Down
21 changes: 15 additions & 6 deletions cores/nRF5/component/rui_v3_api/RAKBleBeacon.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ class cusPayload
* api.ble.beacon.custom.payload.set(cus_adv_data[], cus_adv_len)
* @param cus_adv_data[] set the advertising payload (MAX 31 bytes)
* @param cus_adv_len the number of bytes to advertising data
*
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(uint8_t cus_adv_data[], uint8_t cus_adv_len);

Expand Down Expand Up @@ -47,7 +48,9 @@ app and deployment use case.
* @par Syntax
* api.ble.beacon.ibeacon.uuid.set(beaconUuid)
* @param beaconUuid define 16 bytes
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(uint8_t beaconUuid[]);
};
Expand All @@ -63,7 +66,9 @@ the UUID.
* @par Syntax
* api.ble.beacon.ibeacon.major.set(major_value)
* @param major_value set major (define 2 bytes)
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(uint16_t major_value);
};
Expand All @@ -78,7 +83,9 @@ application developer
* @par Syntax
* api.ble.beacon.ibeacon.minor.set(minor_value)
* @param minor_value set minor (define 2 bytes)
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(uint16_t minor_value);
};
Expand All @@ -92,7 +99,9 @@ application developer
* @par Syntax
* api.ble.beacon.ibeacon.power.set(ibeacon_power)
* @param ibeacon_power display measured power value (RSSI)
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(int8_t ibeacon_power);
};
Expand Down
4 changes: 3 additions & 1 deletion cores/nRF5/component/rui_v3_api/RAKBleCus.h
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ class RAKBleCharacteristic
* @par Syntax
* bslc.notifyEnabled()
* @return void
* @return bool
* @retval TRUE : The mobile apps notification is enabled
* @retval FALSE : The mobile apps notification is not enabled
*/
bool notifyEnabled(void);

Expand Down
27 changes: 18 additions & 9 deletions cores/nRF5/component/rui_v3_api/RAKBleSettings.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#include "AString.h"

/**
* @ingroup BLE_Data_Type
* @ingroup BLE_Setting
*/
typedef enum
{
Expand All @@ -31,7 +31,9 @@ class RAKBleSettings {
*
* @param txpwr The TX power level (dBm), which can be one of the following values (from lowest to higher transmit power):\n
0~8 , -4,-8,-12,-16,-20,-40
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(int8_t txpwr);

Expand All @@ -55,7 +57,9 @@ class RAKBleSettings {
* api.bel.setting.advertiseInterval.set(adv_interval)
*
* @param adv_interval 1000ms ~10240ms
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(int32_t adv_interval);

Expand All @@ -81,7 +85,9 @@ class RAKBleSettings {
*
* @param ble_name setting device name an array of data to send as bytes
* @param device_name_length the number of bytes to transmit
* @return TRUE for success SET,FALSE for SET fail(Type: bool)
* @return bool
* @retval TRUE for success
* @retval FALSE for failure
*/
bool set(char *ble_name, uint8_t device_name_length);

Expand Down Expand Up @@ -131,16 +137,19 @@ class RAKBleAdvertise {
* @par Syntax
* api.ble.advertise.start(adv_time)
* @param adv_time advertising timeout in seconds. If x = 0, advertising never stops
* @return True for start advertising success, false for start advertising fail(Type: bool)
* @return bool
* @retval TRUE for start advertising success
* @retval FALSE for for start advertising failure
*/
bool start(uint8_t adv_time);

/**@par Description
* Used to stop advertising
* @par Syntax
* api.ble.advertise.stop()
*
* @return True for stop advertising success,false for stop advetising fail(Type: bool)
@return bool
@retval TRUE for stop advertising success
@retval FALSE for for stop advertising failure
* @par Example
* @verbatim
void setup()
Expand All @@ -162,8 +171,8 @@ class RAKBleAdvertise {
* api.ble.advertise.status()
*
* @return bool
* @retval 0 the device is in advertising
* @retval 1 the device is adverting
* @retval TRUE : the device is in advertising
* @retval FALSE : the device is stop advertis
*/
bool status();
};
Expand Down
Loading

0 comments on commit 5430cc3

Please sign in to comment.