Skip to content

Commit a2dd734

Browse files
coleHafnercoleHafner
authored
feat: add support for ground fix (#38)
* feat: added support for ground_fix * chore: added pr template * fix: fix typo * refactor: add template to .github dir * fix: fixed filenames
1 parent 1177d31 commit a2dd734

10 files changed

+376
-23
lines changed

‎__tests__/schemas.spec.ts

+22-18
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,44 @@ import { isValidSchema, getValidationWithDependencies } from '../utilities';
1111

1212
// @ts-ignore
1313
const testGroup = ({ schemaName, schema, schemaTests }) => {
14-
const chosen = Array.isArray(schemaTests) ? [schemaTests] : schemaTests;
14+
// pgps has an array response that is valid that needs to be converted to an array of arrays
15+
const chosen =
16+
schemaName === 'pgps' && Array.isArray(schemaTests)
17+
? [schemaTests]
18+
: schemaTests;
19+
1520
test.each<Schema>(chosen)('%p', (example) => {
1621
expect(isValidSchema(schema, example)).toEqual(true);
1722
});
1823
};
1924

20-
describe('Validate examples for cloud to device', () => {
25+
const header = (name: string) => `
26+
***************************************************
27+
${name.toUpperCase()}
28+
***************************************************
29+
`;
30+
31+
describe(header('device >>> cloud'), () => {
2132
const { schemasRecords } = getSchemaTestCollection(
22-
SchemaCollectionName.CloudToDevice,
23-
);
24-
describe.each<SchemaRecord>(schemasRecords)(
25-
'$schemaName',
26-
testGroup
33+
SchemaCollectionName.DeviceToCloud,
2734
);
35+
36+
// console.log(`schemaRecords, ${JSON.stringify(schemasRecords, null, 2)}`);
37+
describe.each<SchemaRecord>(schemasRecords)('$schemaName', testGroup);
2838
});
2939

30-
describe('Validate examples for device to cloud', () => {
40+
describe(header('cloud >>> device'), () => {
3141
const { schemasRecords } = getSchemaTestCollection(
32-
SchemaCollectionName.DeviceToCloud,
33-
);
34-
describe.each<SchemaRecord>(schemasRecords)(
35-
'$schemaName',
36-
testGroup,
42+
SchemaCollectionName.CloudToDevice,
3743
);
44+
describe.each<SchemaRecord>(schemasRecords)('$schemaName', testGroup);
3845
});
3946

40-
describe('Validate examples for the device shadow', () => {
47+
describe(header('device shadow'), () => {
4148
const { schemasRecords } = getSchemaTestCollection(
4249
SchemaCollectionName.DeviceShadow,
4350
);
44-
describe.each<SchemaRecord>(schemasRecords)(
45-
'$schemaName',
46-
testGroup,
47-
);
51+
describe.each<SchemaRecord>(schemasRecords)('$schemaName', testGroup);
4852
});
4953

5054
describe('Validate example for dependencies', () => {

‎package.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
"module": "dist/index.mjs",
77
"type": "module",
88
"scripts": {
9-
"test": "jest",
9+
"fix": "npm run prettier:fix",
1010
"lint": "npm run tslint && npm run prettier:lint",
11-
"tslint": "tslint --project ./tsconfig.json",
1211
"prettier": "prettier --write \"./__tests__/**/*.ts\"",
12+
"test": "jest",
13+
"tslint": "tslint --project ./tsconfig.json",
14+
"prettier:fix": "prettier \"./__tests__/**/*.ts\" --write",
1315
"prettier:lint": "prettier --list-different \"./__tests__/**/*.ts\"",
1416
"build": "rollup -c rollup.config.js"
1517
},

‎schemas/cloudToDevice/ground_fix/ground-fix-err-example.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"appId": "GROUND_FIX",
3+
"messageType": "DATA",
4+
"err": 50010
5+
}

‎schemas/cloudToDevice/ground_fix/ground-fix-example.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"appId": "GROUND_FIX",
3+
"messageType": "DATA",
4+
"data": {
5+
"lat": -45,
6+
"lon": 100,
7+
"uncertainty": 500
8+
}
9+
}

‎schemas/cloudToDevice/ground_fix/ground-fix.json

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
{
2+
"title":"Ground Fix Response",
3+
"description":"Responds with coordinates",
4+
"type":"object",
5+
"properties":{
6+
"appId":{
7+
"type":"string",
8+
"const":"GROUND_FIX"
9+
},
10+
"messageType":{
11+
"type":"string",
12+
"const":"DATA"
13+
},
14+
"data":{
15+
"type":"object",
16+
"properties":{
17+
"lat":{
18+
"$ref": "#/definitions/Lat"
19+
},
20+
"lon":{
21+
"$ref": "#/definitions/Lon"
22+
},
23+
"uncertainty":{
24+
"$ref": "#/definitions/Uncertainty"
25+
},
26+
"fulfilledWith":{
27+
"$ref": "#/definitions/FulfilledWith"
28+
}
29+
},
30+
"additionalProperties":false
31+
},
32+
"err": {
33+
"type": "integer"
34+
}
35+
},
36+
"additionalProperties":false,
37+
"required":[
38+
"appId",
39+
"messageType"
40+
],
41+
"definitions": {
42+
"Lat":{
43+
"type":"number",
44+
"description":"GPS latitude",
45+
"minimum": -90,
46+
"maximum": 90
47+
},
48+
"Lon":{
49+
"type":"number",
50+
"description":"GPS longitude",
51+
"minimum": -180,
52+
"maximum": 180
53+
},
54+
"Uncertainty":{
55+
"type":"integer",
56+
"description":"HPE (horizontal positioning error) in meters"
57+
},
58+
"FulfilledWith": {
59+
"enum": ["MCELL", "SCELL", "WIFI"],
60+
"description": "How the request was fulfilled. WIFI is prioritized by the cloud. Falls back to SCELL/MCELL."
61+
}
62+
}
63+
}

‎schemas/deviceToCloud/ground_fix/ground-fix-example.json

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"appId": "GROUND_FIX",
3+
"messageType": "DATA",
4+
"data": {
5+
"doReply": false,
6+
"wifi": {
7+
"accessPoints": [
8+
{
9+
"macAddress": "fd:70:40:b9:58:dc"
10+
},
11+
{
12+
"macAddress": "c5:ab:c7:55:8d:e3"
13+
}
14+
]
15+
},
16+
"lte": [
17+
{
18+
"mnc": 260,
19+
"mcc": 310,
20+
"eci": 21858829,
21+
"tac": 333,
22+
"rsrp": -157,
23+
"rsrq": -34.5,
24+
"earfcn": 41490,
25+
"nmr": [
26+
{
27+
"pci": 143,
28+
"earfcn": 41490,
29+
"rsrp": -44,
30+
"rsrq": -3.5
31+
}
32+
]
33+
}
34+
]
35+
}
36+
}

‎schemas/deviceToCloud/ground_fix/ground-fix-lte-only-example.json

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"appId": "GROUND_FIX",
3+
"messageType": "DATA",
4+
"data": {
5+
"doReply": false,
6+
"lte": [
7+
{
8+
"mnc": 260,
9+
"mcc": 310,
10+
"eci": 21858829,
11+
"tac": 333,
12+
"rsrp": -157,
13+
"rsrq": -34.5,
14+
"earfcn": 41490,
15+
"nmr": [
16+
{
17+
"pci": 143,
18+
"earfcn": 41490,
19+
"rsrp": -44,
20+
"rsrq": -3.5
21+
}
22+
]
23+
}
24+
]
25+
}
26+
}

‎schemas/deviceToCloud/ground_fix/ground-fix-wifi-only-example.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"appId": "GROUND_FIX",
3+
"messageType": "DATA",
4+
"data": {
5+
"doReply": false,
6+
"wifi": {
7+
"accessPoints": [
8+
{
9+
"macAddress": "fd:70:40:b9:58:dc"
10+
},
11+
{
12+
"macAddress": "c5:ab:c7:55:8d:e3"
13+
}
14+
]
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)