ppetru/opensprinkler-weather
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Include an error code in every response

Browse Source
This commit is contained in:
Matthew Oslan
2019-08-31 18:36:25 -04:00
parent 9b99b993ab
commit d77553bce4
2 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
errors.ts
View File

@@ -1,6 +1,8 @@
export enum ErrorCode { export enum ErrorCode {
/** An error was not properly handled and assigned a more specific error code. */ /** No error occurred. This code should be included with all successful responses because the firmware expects some
UnexpectedError = 0, * code to be present.
*/
NoError = 0,
/** The watering scale could not be calculated due to a problem with the weather information. */ /** The watering scale could not be calculated due to a problem with the weather information. */
BadWeatherData = 1, BadWeatherData = 1,
@@ -46,7 +48,10 @@ export enum ErrorCode {
/** The adjustment options could not be parsed. */ /** The adjustment options could not be parsed. */
MalformedAdjustmentOptions = 50, MalformedAdjustmentOptions = 50,
/** A required adjustment option was not provided. */ /** A required adjustment option was not provided. */
MissingAdjustmentOption = 51 MissingAdjustmentOption = 51,
/** An error was not properly handled and assigned a more specific error code. */
UnexpectedError = 99
} }
/** An error with a numeric code that can be used to identify the type of error. */ /** An error with a numeric code that can be used to identify the type of error. */

4
routes/weather.ts
View File

@@ -262,7 +262,8 @@ export const getWateringData = async function( req: express.Request, res: expres
sunset: timeData.sunset, sunset: timeData.sunset,
eip: ipToInt( remoteAddress ), eip: ipToInt( remoteAddress ),
rawData: undefined, rawData: undefined,
errMessage: undefined errMessage: undefined,
errCode: 0
}; };
let cachedScale: CachedScale; let cachedScale: CachedScale;
@@ -293,6 +294,7 @@ export const getWateringData = async function( req: express.Request, res: expres
} }
data.scale = adjustmentMethodResponse.scale; data.scale = adjustmentMethodResponse.scale;
data.errCode = adjustmentMethodResponse.errCode || 0;
data.errMessage = adjustmentMethodResponse.errMessage; data.errMessage = adjustmentMethodResponse.errMessage;
data.rd = adjustmentMethodResponse.rainDelay; data.rd = adjustmentMethodResponse.rainDelay;
data.rawData = adjustmentMethodResponse.rawData; data.rawData = adjustmentMethodResponse.rawData;