该全单位测试的库使您可以在Arduino侧编码数据并在TTN侧进行解码。它同时提供基于C的编码器和基于JavaScript的解码器。
由于版本2.2.0,也有针对TTN侧的编码器。
Arduino方面:
# include " LoraMessage.h "
LoraMessage message;
message
.addUnixtime( 1467632413 )
.addLatLng(- 33.905052 , 151.26641 );
lora_send_bytes (message.getBytes(), message.getLength());
delete message;ttn侧:
function decodeUplink ( input )
{
// decoder function according to https://www.thethingsindustries.com/docs/integrations/payload-formatters/javascript/uplink/
// input has the following structure:
// {
// "bytes": [1, 2, 3], // FRMPayload (byte array)
// "fPort": 1
// }
var data = decode ( input . bytes , [ unixtime , latLng ] , [ 'time' , 'coords' ] ) ;
return { data : data }
}
// include content from src/decoder.js:
var bytesToInt = function ( bytes ) {
var i = 0 ;
for ( var x = 0 ; x < bytes . length ; x ++ ) {
i |= + ( bytes [ x ] << ( x * 8 ) ) ;
}
return i ;
} ;
...ttn侧:
// include src/encoder.js
var bytes = encode ( [ timestamp , [ latitude , longitude ] ] , [ unixtime , latLng ] ) ;
// bytes is of type Buffer // include src/encoder.js
// include src/LoraMessage.js
var bytes = new LoraMessage ( encoder )
. addUnixtime ( 1467632413 )
. addLatLng ( - 33.905052 , 151.26641 )
. addBitmap ( true , true , false , true )
. getBytes ( ) ;
// bytes = <Buffer 1d 4b 7a 57 64 a6 fa fd 6a 24 04 09 d0>然后像往常一样解码:
var result = decoder . decode (
bytes ,
[ decoder . unixtime , decoder . latLng , decoder . bitmap ] ,
[ 'time' , 'coords' , 'heaters' ]
) ;
// result =
// { time: 1467632413,
// coords: [ -33.905052, 151.26641 ],
// heaters:
// { a: true,
// b: true,
// c: false,
// d: true,
// e: false,
// f: false,
// g: false,
// h: false } } 序列化/应对UNIX时间(秒)
# include " LoraEncoder.h "
byte buffer[ 4 ];
LoraEncoder encoder (buffer);
encoder.writeUnixtime( 1467632413 );
// buffer == {0x1d, 0x4b, 0x7a, 0x57}然后在TTN前端,使用以下方法:
unixtime ( input . bytes . slice ( x , x + 4 ) ) // 1467632413序列化/应序列化坐标(纬度/经度),精度为6个小数。
# include " LoraEncoder.h "
byte buffer[ 8 ];
LoraEncoder encoder (buffer);
encoder.writeLatLng(- 33.905052 , 151.26641 );
// buffer == {0x64, 0xa6, 0xfa, 0xfd, 0x6a, 0x24, 0x04, 0x09}然后在TTN前端,使用以下方法:
latLng ( input . bytes . slice ( x , x + 8 ) ) // [-33.905052, 151.26641]序列化/应对未签名的8位整数。
# include " LoraEncoder.h "
byte buffer[ 1 ];
LoraEncoder encoder (buffer);
uint8_t i = 10 ;
encoder.writeUint8(i);
// buffer == {0x0A}然后在TTN前端,使用以下方法:
uint8 ( input . bytes . slice ( x , x + 1 ) ) // 10序列化/应对未签名的16位整数。
# include " LoraEncoder.h "
byte buffer[ 2 ];
LoraEncoder encoder (buffer);
uint16_t i = 23453 ;
encoder.writeUint16(i);
// buffer == {0x9d, 0x5b}然后在TTN前端,使用以下方法:
uint16 ( input . bytes . slice ( x , x + 2 ) ) // 23453序列化/应对未签名的32位整数。
# include " LoraEncoder.h "
byte buffer[ 4 ];
LoraEncoder encoder (buffer);
uint32_t i = 2864434397 ;
encoder.writeUint32(i);
// buffer == {0xdd, 0xcc, 0xbb, 0xaa}然后在TTN前端,使用以下方法:
uint32 ( input . bytes . slice ( x , x + 4 ) ) // 2864434397序列化/应对-327.68和+327.67(包含)的温度读数,精度为2个小数。
# include " LoraEncoder.h "
byte buffer[ 2 ];
LoraEncoder encoder (buffer);
encoder.writeTemperature(- 123.45 );
// buffer == {0xcf, 0xc7}然后在TTN前端,使用以下方法:
temperature ( input . bytes . slice ( x , x + 2 ) ) // -123.45序列化/应对0到100(包含)的湿度读数,精度为2个小数。
# include " LoraEncoder.h "
byte buffer[ 2 ];
LoraEncoder encoder (buffer);
encoder.writeHumidity( 99.99 );
// buffer == {0x0f, 0x27}然后在TTN前端,使用以下方法:
humidity ( input . bytes . slice ( x , x + 2 ) ) // 99.99序列化/应对完整的4字节浮子。
# include " LoraEncoder.h "
byte buffer[ 4 ];
LoraEncoder encoder (buffer);
encoder.writeRawFloat( 99.99 );
// buffer == {0xe1, 0xfa, 0xc7, 0x42}然后在TTN前端,使用以下方法:
rawfloat ( input . bytes . slice ( x , x + 4 ) ) // 99.99序列化/供应序列化,其中包含0到8个不同标志之间的位图。
# include " LoraEncoder.h "
byte buffer[ 1 ];
LoraEncoder encoder (buffer);
encoder.writeBitmap( true , false , false , false , false , false , false , false );
// buffer == {0x80}然后在TTN前端,使用以下方法:
bitmap ( input . bytes . slice ( x , x + 1 ) ) // { a: true, b: false, c: false, d: false, e: false, f: false, g: false, h: false } 解码器允许您为字节数组编写多个值:
# include " LoraEncoder.h "
byte buffer[ 19 ];
LoraEncoder encoder (buffer);
encoder.writeUnixtime( 1467632413 );
encoder.writeLatLng(- 33.905052 , 151.26641 );
encoder.writeUint8( 10 );
encoder.writeUint16( 23453 );
encoder.writeUint32( 2864434397 );
encoder.writeTemperature( 80.12 );
encoder.writeHumidity( 99.99 );
encoder.writeRawFloat( 99.99 );
encoder.writeBitmap( true , false , false , false , false , false , false , false );
/* buffer == {
0x1d, 0x4b, 0x7a, 0x57, // Unixtime
0x64, 0xa6, 0xfa, 0xfd, 0x6a, 0x24, 0x04, 0x09, // latitude,longitude
0x0A, // Uint8
0x9d, 0x5b, // Uint16
0xdd, 0xcc, 0xbb, 0xaa, // Uint32
0x1f, 0x4c, // temperature
0x0f, 0x27, // humidity
0xe1, 0xfa, 0xc7, 0x42, // 4-byte float
0x80 // bitmap
}
*/ LoraMessage有一个便利类代表一个可以将读数添加到:
# include " LoraMessage.h "
LoraMessage message;
message
.addUnixtime( 1467632413 )
.addLatLng(- 33.905052 , 151.26641 )
.addUint8( 10 )
.addUint16( 23453 )
.addUint32( 2864434397 )
.addTemperature( 80.12 )
.addHumidity( 99.99 )
.addRawFloat( 99.99 )
.addBitmap( false , false , false , false , false , false , true , false );
send (message.getBytes(), message.getLength());
/*
getBytes() == {
0x1d, 0x4b, 0x7a, 0x57, // Unixtime
0x64, 0xa6, 0xfa, 0xfd, 0x6a, 0x24, 0x04, 0x09, // latitude,longitude
0x0A, // Uint8
0x9d, 0x5b, // Uint16
0xdd, 0xcc, 0xbb, 0xaa, // Uint32
0x1f, 0x4c, // temperature
0x0f, 0x27, // humidity
0xe1, 0xfa, 0xc7, 0x42, // 4-byte float
0xfd // Bitmap
}
and
getLength() == 28
*/decode方法在TTN解码器前端中的组成decode方法允许您指定传入字节缓冲区(该库生成)并相应地应用解码功能的掩码。
decode ( byte Array , mask Array [ , mapping Array ] ) 将所有从src/decoder.js粘贴到解码器方法中,然后使用:
function ( bytes ) {
// code from src/decoder.js here
return decode ( bytes , [ latLng , unixtime ] , [ 'coords' , 'time' ] ) ;
}这将传入的字节缓冲区的12个字节映射到一个latLng (8个字节)和一个unixtime (4个字节)序列的序列,然后将第一个序列映射到键coords ,然后将其映射到关键time 。
您可以使用: 64 A6 FA FD 6A 24 04 09 1D 4B 7A 57进行测试,它将导致:
{
"coords" : [
-33.905052 ,
151.26641
],
"time" : 1467632413
}在控制台中设置解码器:
解码方法已经完成了大多数必要的转换,因此在大多数情况下,您可以通过数据传递:
yarn安装依赖项yarn run test:cyarn test运行单元测试(JavaScript)yarn coverage检查覆盖范围(JavaScript)(请参阅coverage/lcov-report )一旦您自动创建拉动请求,CI就会开始。
将lora-serialization依赖性添加到您的ESP-IDF项目中的main/idf_component.yml文件:
dependencies:
lora-serialization:
git: https://github.com/thesolarnomad/lora-serialization.git
以及main/CMakeLists.txt
idf_component_register( ...
REQUIRES .... lora-serialization
)