TTNHABBridge - Revision history

Bertrik Sikken: /* Payload encoder/decoder */

2022-04-21T15:25:48Z

Payload encoder/decoder

← Older revision		Revision as of 15:25, 21 April 2022
Line 141:		Line 141:
	This part decodes the binary payload received from the TTN into a standard habitat sentence.		This part decodes the binary payload received from the TTN into a standard habitat sentence.

	The bridge application currently allows the following encodings for the telemetry data, configurable in the application ~~properties~~:		The bridge application currently allows the following encodings for the telemetry data, configurable in the application configuration:
	* 'cayenne' (recommended): [https://mydevices.com/cayenne/docs/lora/#lora-cayenne-low-power-payload "cayenne" encoding]		* 'cayenne' (recommended): [https://mydevices.com/cayenne/docs/lora/#lora-cayenne-low-power-payload "cayenne" encoding]
	* 'sodaqone': [https://github.com/SodaqMoja/SodaqOne-UniversalTracker SodaqOne universal tracker] conventions.		* 'sodaqone': [https://github.com/SodaqMoja/SodaqOne-UniversalTracker SodaqOne universal tracker] conventions.

2022-04-21T15:25:30Z

Running the software from the zip-file / tar-ball

← Older revision		Revision as of 15:25, 21 April 2022
Line 87:		Line 87:
	bin/ttnhabbridge		bin/ttnhabbridge
	* stop it, using CTRL-C		* stop it, using CTRL-C
	* edit the ttnhabbridge.~~properties~~ configuration file with a text editor, enter your application name, keys, payload encoding, etc.		* edit the ttnhabbridge.yaml configuration file with a text editor, enter your application name, keys, payload encoding, etc.
	* run it again and verify that the program starts correctly with the new configuration file		* run it again and verify that the program starts correctly with the new configuration file

2022-04-21T15:25:13Z

Running the software from the zip-file / tar-ball

← Older revision		Revision as of 15:25, 21 April 2022
Line 88:		Line 88:
	* stop it, using CTRL-C		* stop it, using CTRL-C
	* edit the ttnhabbridge.properties configuration file with a text editor, enter your application name, keys, payload encoding, etc.		* edit the ttnhabbridge.properties configuration file with a text editor, enter your application name, keys, payload encoding, etc.
	* run it again and verify that the program starts correctly with the new ~~properties~~ file		* run it again and verify that the program starts correctly with the new configuration file

	=== Design ===		=== Design ===

2022-04-21T15:24:51Z

Running the software from the zip-file / tar-ball

← Older revision		Revision as of 15:24, 21 April 2022
Line 83:		Line 83:
	=== Running the software from the zip-file / tar-ball ===		=== Running the software from the zip-file / tar-ball ===
	* extract either the tar (Linux) or zip (Windows) that was generated in the build step		* extract either the tar (Linux) or zip (Windows) that was generated in the build step
	* run it once to generate the initial configuration file, this file is called ttnhabbridge.~~properties~~		* run it once to generate the initial configuration file, this file is called ttnhabbridge.yaml
	cd ttnhabbridge		cd ttnhabbridge
	bin/ttnhabbridge		bin/ttnhabbridge

2022-04-21T15:22:40Z

Running the software using Docker

← Older revision		Revision as of 15:22, 21 April 2022
Line 68:		Line 68:
	To be documented ...		To be documented ...

	~~Basically: get the source,~~ install docker and docker-compose, enter the 'docker' directory, edit the config file~~, start~~ docker ~~using '~~docker-compose up'		* install docker and docker-compose
			sudo apt install docker-ce ?
			* get the source code
			git clone https://github.com/bertrik/ttnhabbridge
			* enter the docker directory
			cd ttnhabbridge
			cd docker
			* edit the config file
			* get the docker image
			docker-compose pull
			* run the docker image
			docker-compose up

	=== Running the software from the zip-file / tar-ball ===		=== Running the software from the zip-file / tar-ball ===

2022-04-20T12:52:55Z

Next steps

← Older revision		Revision as of 12:52, 20 April 2022
Line 16:		Line 16:
	Future development:		Future development:
	* add support for running this in a Docker container: has been realized, but not documented yet		* add support for running this in a Docker container: has been realized, but not documented yet
	* add support for sondehub		* add support for sondehub, see also https://github.com/bertrik/ttnhabbridge/issues/6
	** need to implement data structures		** need to implement data structures
	** need to restructure internals: sondehub uses a JSON structure, not a 'sentence' like UKHAS does		** need to restructure internals: sondehub uses a JSON structure, not a 'sentence' like UKHAS does

2022-04-19T07:24:13Z

Running the software using Docker

← Older revision		Revision as of 07:24, 19 April 2022
Line 67:		Line 67:
	=== Running the software using Docker ===		=== Running the software using Docker ===
	To be documented ...		To be documented ...

			Basically: get the source, install docker and docker-compose, enter the 'docker' directory, edit the config file, start docker using 'docker-compose up'

	=== Running the software from the zip-file / tar-ball ===		=== Running the software from the zip-file / tar-ball ===

2022-04-19T07:23:21Z

Software

← Older revision		Revision as of 07:23, 19 April 2022
Line 65:		Line 65:
	* the executable is now available at ttnhabbridge/build/distributions/ttnhabbridge.tar and ttnhabbridge.zip		* the executable is now available at ttnhabbridge/build/distributions/ttnhabbridge.tar and ttnhabbridge.zip

	=== Running the software ===		=== Running the software using Docker ===
			To be documented ...

			=== Running the software from the zip-file / tar-ball ===
	* extract either the tar (Linux) or zip (Windows) that was generated in the build step		* extract either the tar (Linux) or zip (Windows) that was generated in the build step
	* run it once to generate the initial configuration file, this file is called ttnhabbridge.properties		* run it once to generate the initial configuration file, this file is called ttnhabbridge.properties

2022-04-19T07:22:19Z

Source code

← Older revision		Revision as of 07:22, 19 April 2022
Line 50:		Line 50:

	The README explains the tool chain setup.		The README explains the tool chain setup.

	~~Using this source code, the basic functionality works.~~

	~~There is no user guide yet, but the .properties settings file has a one-line comment explaining what each setting does.~~

	=== Building the software ===		=== Building the software ===

2022-04-19T07:19:21Z

Status

← Older revision		Revision as of 07:19, 19 April 2022
Line 12:		Line 12:
	It has been tested in practice with the 'koppelting1' payload on 2017-8-26.		It has been tested in practice with the 'koppelting1' payload on 2017-8-26.
	If you look at the [https://tracker.habhub.org/ habhub map] and see a receiver called EUI-xxxxxxxx then that one is probably generated by this software.		If you look at the [https://tracker.habhub.org/ habhub map] and see a receiver called EUI-xxxxxxxx then that one is probably generated by this software.

			=== Next steps ===
			Future development:
			* add support for running this in a Docker container: has been realized, but not documented yet
			* add support for sondehub
			** need to implement data structures
			** need to restructure internals: sondehub uses a JSON structure, not a 'sentence' like UKHAS does

	== Introduction ==		== Introduction ==