-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 8276b53
Showing
9 changed files
with
440 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,214 @@ | ||
/* | ||
MIT License | ||
Copyright (c) 2021 Felix Biego | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
*/ | ||
|
||
#include "Arduino.h" | ||
#include <HTTPClient.h> | ||
|
||
extern "C" { | ||
#include "crypto/base64.h" | ||
} | ||
|
||
#include "MpesaSTK.h" | ||
|
||
/*! | ||
@brief Constructor for MpesaSTK | ||
@param consumer_key | ||
Consumer Key: https://developer.safaricom.co.ke/user/me/apps | ||
@param consumer_secret | ||
Consumer Secret: https://developer.safaricom.co.ke/user/me/apps | ||
@param pass_key | ||
Lipa Na Mpesa Online PassKey: https://developer.safaricom.co.ke/test_credentials | ||
@param environment | ||
Environment: SANDBOX(default), PRODUCTION | ||
*/ | ||
MpesaSTK::MpesaSTK(String consumer_key, String consumer_secret, String pass_key, String environment){ | ||
_consumer_key = consumer_key; | ||
_consumer_secret = consumer_secret; | ||
_pass_key = pass_key; | ||
_environment = environment; | ||
} | ||
|
||
/*! | ||
@brief begin | ||
@param code | ||
Lipa Na Mpesa Online Shortcode | ||
@param type | ||
Transaction Type: PAYBILL(default), BUY_GOODS | ||
@param url | ||
callback url | ||
@param gmt | ||
GMT offset | ||
*/ | ||
void MpesaSTK::begin(int code, String type, String url, int gmt, bool set){ | ||
|
||
_business_code = code; | ||
_transaction_type = type; | ||
_callback_url = url; | ||
|
||
if (set){ | ||
setTime(gmt); | ||
} | ||
|
||
} | ||
|
||
/*! | ||
@brief initiate the payment process | ||
@param number | ||
12 digit phone number (2457XXXXXXXX) | ||
@param amount | ||
Amount to be paid | ||
@param reference | ||
Transaction reference | ||
@param description | ||
Transaction description | ||
*/ | ||
String MpesaSTK::pay(String number, int amount, String reference, String description){ | ||
_number = number; | ||
_amount = amount; | ||
_reference = reference; | ||
_description = description; | ||
|
||
if (getToken()){ | ||
return stkPush(); | ||
} else { | ||
return "{\"Result\":\"failed\",\"Message\":\"Failed to get an access token\"}"; | ||
} | ||
} | ||
|
||
/*! | ||
@brief get the access token | ||
*/ | ||
bool MpesaSTK::getToken(){ | ||
String encoded = encoder64(_consumer_key + ":" + _consumer_secret); | ||
HTTPClient http; | ||
http.begin(_environment + "oauth/v1/generate?grant_type=client_credentials"); | ||
http.addHeader("authorization", "Basic " + encoded); | ||
http.addHeader("cache-control", "no-cache"); | ||
int httpCode = http.GET(); | ||
bool success = false; | ||
if (httpCode > 0) { | ||
if (httpCode == HTTP_CODE_OK) { | ||
String payload = http.getString(); | ||
payload.replace("\n", ""); | ||
payload.replace(" ", ""); | ||
String st = "{\"access_token\":\""; | ||
int start = payload.indexOf(st); | ||
int end = payload.indexOf("\",\"expires_in\":"); | ||
if (start != -1 && end != -1){ | ||
_token = payload.substring(st.length(), end); | ||
success = true; | ||
} | ||
} | ||
} | ||
http.end(); | ||
return success; | ||
} | ||
|
||
/*! | ||
@brief encodes the input string in base64 format | ||
@param input | ||
String to be encoded | ||
*/ | ||
String MpesaSTK::encoder64(String input){ | ||
char toEncode[input.length() + 1]; | ||
input.toCharArray(toEncode, input.length() + 1); | ||
size_t outputLength; | ||
unsigned char * encoded = base64_encode((const unsigned char *)toEncode, strlen(toEncode), &outputLength); | ||
String encodedString = (const char*)encoded; | ||
free(encoded); | ||
encodedString.replace("\n", ""); | ||
return encodedString; | ||
} | ||
|
||
/*! | ||
@brief set the time | ||
*/ | ||
void MpesaSTK::setTime(int gmt, int dst){ | ||
configTime(gmt * 3600, dst * 3600, "pool.ntp.org", "time.nist.gov"); | ||
time_t nowSecs = time(nullptr); | ||
while (nowSecs < 1619827200) { | ||
delay(500); | ||
yield(); | ||
nowSecs = time(nullptr); | ||
} | ||
struct tm timeinfo; | ||
gmtime_r(&nowSecs, &timeinfo); | ||
} | ||
|
||
/*! | ||
@brief get the internal RTC time as a tm struct | ||
*/ | ||
tm MpesaSTK::getTimeStruct(){ | ||
struct tm timeinfo; | ||
getLocalTime(&timeinfo); | ||
return timeinfo; | ||
} | ||
|
||
/*! | ||
@brief get the time as an Arduino String object with the specified format | ||
@param format | ||
time format | ||
http://www.cplusplus.com/reference/ctime/strftime/ | ||
*/ | ||
String MpesaSTK::getTime(String format){ | ||
struct tm timeinfo = getTimeStruct(); | ||
char s[128]; | ||
char c[128]; | ||
format.toCharArray(c, 127); | ||
strftime(s, 127, c, &timeinfo); | ||
return String(s); | ||
} | ||
|
||
/*! | ||
@brief perform the STK request | ||
*/ | ||
String MpesaSTK::stkPush(){ | ||
String timestamp = getTime("%Y%m%d%H%M%S"); | ||
String password = encoder64(_business_code + _pass_key + timestamp); | ||
String json = "{\"BusinessShortCode\":\"" + String(_business_code) + "\",\"Password\":\"" + password + "\",\"Timestamp\":\"" + timestamp + "\",\"TransactionType\":\"" + _transaction_type + "\",\"Amount\":\"" + String(_amount) + "\",\"PartyA\":\"" + _number + "\",\"PartyB\":\"" + String(_business_code) + "\",\"PhoneNumber\":\"" + _number + "\",\"CallBackURL\":\"" + _callback_url + "\",\"AccountReference\":\"" + _reference + "\",\"TransactionDesc\":\"" + _description + "\"}"; | ||
|
||
HTTPClient http; | ||
http.begin(_environment + "mpesa/stkpush/v1/processrequest"); | ||
http.addHeader("Content-Type", "application/json"); | ||
http.addHeader("authorization", "Bearer " + _token); | ||
http.addHeader("cache-control", "no-cache"); | ||
int httpCode = http.POST(json); | ||
String result = ""; | ||
if (httpCode > 0) { | ||
if (httpCode == HTTP_CODE_OK) { | ||
String payload = http.getString(); | ||
payload.replace("\n", ""); | ||
payload.replace(" ", ""); | ||
payload.replace("}", ",\"Result\":\"success\",\"HttpCode\":\"" + String(httpCode) + "\"}"); | ||
result = payload; | ||
} else { | ||
result = "{\"Result\":\"failed\",\"HttpCode\":\"" + String(httpCode) + "\"}"; | ||
} | ||
} else { | ||
result = "{\"Result\":\"failed\",\"HttpCode\":\"" + String(httpCode) + "\"}"; | ||
} | ||
|
||
http.end(); | ||
return result; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
/* | ||
MIT License | ||
Copyright (c) 2021 Felix Biego | ||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. | ||
*/ | ||
|
||
#ifndef MPESASTK_H | ||
#define MPESASTK_H | ||
|
||
#include <Arduino.h> | ||
|
||
|
||
#define SANDBOX "https://sandbox.safaricom.co.ke/" | ||
#define PRODUCTION "https://api.safaricom.co.ke/" | ||
|
||
#define PAYBILL "CustomerPayBillOnline" | ||
#define BUY_GOODS "CustomerBuyGoodsOnline" | ||
|
||
|
||
#define TEST_CODE 174379 | ||
|
||
class MpesaSTK { | ||
|
||
public: | ||
MpesaSTK(String consumer_key, String consumer_secret, String pass_key, String environment = SANDBOX); | ||
void begin(int code = TEST_CODE, String type = PAYBILL, String url = "http://mycallbackurl.com/checkout.php", int gmt = 3, bool set = true); | ||
String pay(String number, int amount, String reference, String description); | ||
|
||
private: | ||
bool getToken(); | ||
String encoder64(String input); | ||
String stkPush(); | ||
void setTime(int gmt, int dst = 0); | ||
String getTime(String format); | ||
tm getTimeStruct(); | ||
|
||
int _amount; | ||
int _business_code; | ||
String _consumer_key; | ||
String _consumer_secret; | ||
String _pass_key; | ||
String _callback_url; | ||
String _transaction_type; | ||
String _token; | ||
String _number; | ||
String _reference; | ||
String _description; | ||
String _environment; | ||
}; | ||
|
||
|
||
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Felix Biego | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# CST816S | ||
An Arduino library for the CST816S capacitive touch screen IC |
Oops, something went wrong.