Update README.md

README.md

@@ -1,165 +1,6 @@
-# GPS/Data Application
+## See the main README (under branch: gps) for more on the operation of the application.
 
-This repository contains everything needed to decode DMR GPS packets and SMS for HBLink3. This application can act as a master or peer and receive data as a group call or private call. It is designed to work in a multi system/user network.
-
-Files modified from original master branch of HBLink3:
-
-* bridge.py
-* config.py 
-
-#### Required modules
-
-* pynmea2
-* aprslib
-* maidenhead
-
-#### Optional Modules
-* Flask - Required for dashboard
-* smtplib - Required for sending email. If pip fails to install module, it may already be installed as most Linux distrobutions have this module by default.
-* slixmpp - Required for upcoming XMPP gateway.
-
-This should work for DMR radios that send location data as a UTF-8 NMEA sentence. I am hopping to add support for more radios in the future.
-
-### Differences in branches
-
-* **GPS**: Contains the GPS/Data Application.
-* **aprs_features**: Contains the GPS/Data Application and a modified version of the APRS implementation for repeaters and hotspots by **IU7IGU**. (See [https://github.com/iu7igu/hblink3-aprs](https://github.com/iu7igu/hblink3-aprs) for his work). I combined these for convenience.
-
-## Confirmed working:
-Actually tested
-
- | Radio | GPS | SMS |
- |-------|:---:|:---:|
- | Anytone D878| YES | YES |
- | Anytone D578| YES | YES |
- | BTech DMR-6x2 | YES | Most likely |
- | MD-380 (MD380tools, no GPS) | - | YES |
- | MD-380 (stock firmware, GPS) | YES | Most likely |
- | MD-390 (stock firmware) | YES | YES |
- | Retevis RT73* | YES | YES |
- | Ailunce HD1 | YES | YES |
- 
- *RT73 must have unconfirmed data setting enabled.
-
-## Highly suspected to work:
-Not tested yet, but will most likely work.
-
- | Radio | GPS | SMS |
- |-------|:---:|:---:|
- | Anytone D868 | Most likely | Most likely |
- | TYT MD-2017 | Most likely | Likely |
- | TYT MD-9600 | Most likely | Likely |
- | Retevis RT8 | Most likely | Likely |
- 
- 
-## Tested, but with issues.
-  Tested, but with bugs present.
-  
- | Radio | GPS | SMS |
- |-------|:---:|:---:|
- | Alinco DJ-MD5TGP | WIP | Most likely |
- | Motorola DP3601| WIP | WIP |
-
-
-## Would like to test:
-
-Connect Systems GPS enabled radios
-
-## Features
-
-* Decode GPS locations and upload APRS position packets
-* Each user/DMR ID can customize APRS position
-* Ability to receive data as a private call or group call
-* Trigger a command or script via DMR SMS
-* Optional web dashboard to show APRS packets uploaded
-* Display bulletins sent via SMS on web dashboard
-
-
-## How it works
-
-A user should configure their radio for the DMR ID of the application and private or group call. When a position is received by the application, it will extract the coordinates and create an APRS position packet. The application will find the callsign of the user based on the sending radio's DMR ID. It is essential to have an up to date subscriber_ids file for this to work. A predefined APRS SSID is appended to the callsign. The APRS location packet is then uploaded to APRS-IS. No setup is required beforehand on the part of the user. This is pretty much "plug and play."
-
-For example, N0CALL has a DMR ID of 1234567. N0CALL's radio sends a position to the application. The application will query the subscriber_ids file for DMR ID 1234567. The result will be N0CALL. An APRS location pack is created and uploaded to APRS-IS.
-
-## Individual user/DMR ID APRS settings
-
-By default, all APRS positions will have an SSID of 15, a default comment, and the callsign of the DMR user. These default settings can be changed. 
-
-The comment, SSID, and icon can be set for each individual user/DMR ID the application sees. The application stores all the setting in a file. You may have different SSIDs, icons, and comments for different DMR IDs. This is done via DMR SMS using the following commands:
-
- | Command | Description | Example |
- |-------|:---:|:---:|
-|**@SSID**|Change SSID of user callsign.|`@SSID 7`|
-|**@ICON**|Change the icon of the APRS position. *See [http://aprs.net/vm/DOS/SYMBOLS.HTM](http://aprs.net/vm/DOS/SYMBOLS.HTM) for icon list.|`@icon /p`|
-|**@COM**|Change the comment of the APRS.|`@COM This is a test comment.`|
-|**@MH**|Set you location by maidenhead grid square. Designed for radios with no GPS or that are not compatable yet.|`@MH DN97uk`| 
-|**@BB**|Post a bulliten to the web dashboard.|`@BB This is a test bulletin.`|
-|**@[CALLSIGN W/ SSID] A-[MESSAGE]**|Send a message to another station via APRS.|`@N0CALL-15 A-This is a test.`|
-|**[EMAIL ADDRESS] E-[MESSAGE]**|Send an email to an email address.|`test@example.org E-This is a test.`| 
-
-
-
-Send a DMR SMS to the configured dmr_data_id in the application with the desired command followed by the value. For example, to change your icon to a dog, the command would be `@ICON /p` (see the icon table for values). Changing your SSID is as simple as `@SSID 7`, and `@COM Testing 123` will change the comment. 
-
-Sending `@BB Test` will result in a post to the bulletin board with the messaage of "Test".
-
-
-**To remove any of the stored values, just send the appropriate command without any input.** `@COM` will remove the stored comment, `@ICON` will remove the stored icon, and `@COM` will remove the strored comment. Any position now reports sent will have the default settings.
-
-
-## Web Dashboard
-
-The web dashboard is completely optional. Python module flask is required for this to work. The web dashboard will display the last 15 positions of radios sent to APRS-IS. The dashboard will also sh user bulletin. A bulletin is a message sent via SMS that will display on the web dashboard. There are several uses for this, including: testing SMS functionality of radio, announcements, and moire. It is a novel feature. The page will automatically reload every 2 minutes. Setup is rather simple. Just modify the example config in the dashboard directory and rename it to dashboard_settings.py. Then start dashboard.py. 
-
-## APRS messaging
-
-**At this time, only sending of messages from DMR SMS to APRS-IS is supported.** I find this feature very pointless because it will only go one way, but someone else may find it important. **Messages from sent from APRS-IS to DMR SMS will not work.** I have not written the code for this yet. It will likley be a long time before this is a possibility.
-
-## Configuration
-
-See hblink_SAMPLE.cfg, rules_SAMPLE.py, and gps_data_SAMPLE.cfg for examples.
-
-## Special thanks to:
-
-**N0MJS** - For creating HBLink and dmr_utils. This project not possible without him.
-
-**IU7IGU** - For creating APRS position beaconing for PEER connections.
-
-**IV3JDV** - For helping debug SMS in Anytone radios.
-
-**KD7LMN** - For pointing out a critical bug.
-
-**KB5PBM** - For helping implement support for MD-380 type radios.
-
-**EI7IG** - For writing the page explaining MD-380 type GPS packets.
-
-**M0GLJ** - For assisting with Motorola testing.
-
-## Resources for DMR data
-
-I spent many hours looking at the following for this project. You may find these links useful.
-
-https://github.com/travisgoodspeed/md380tools/issues/160
-
-https://jpronans.github.io/ei7ig/dmr.html
-
-http://cloud.dstar.su/files/G4KLX/MMDVM/MMDVM%20Specification%2020150922.pdf
-
-https://wiki.brandmeister.network/index.php/NMEA_Location_Reporting
-
-https://forums.radioreference.com/threads/motorola-lrrp-protocol.370081/
-
-https://forums.radioreference.com/threads/lrrp-decoding.359575/
-
-https://github.com/polkabana/go-dmr
-
-https://github.com/nonoo/dmrshark
-
-https://wiki.brandmeister.network/index.php/Compressed_Location_Reporting
-
-All of the ETSI DMR documents (ETSI 102 361-1 through 361-4).
-
-The Shark RF forums.
+This branch is really no different than the other branches. It just has the dashboard disabled, and the example configs modified to make it easier to run on an Android device.
 
 ---
 ### FOR SUPPORT, DISCUSSION, GETTING INVOLVED ###

bridge_gps_data-SAMPLE.cfg

@@ -84,7 +84,7 @@ REPORT_CLIENTS: 127.0.0.1
 #   used.
 #
 [LOGGER]
-LOG_FILE: /tmp/hblink.log
+LOG_FILE: ./hblink.log
 LOG_HANDLERS: console-timed
 LOG_LEVEL: DEBUG
 LOG_NAME: HBlink

bridge_gps_data.py

@@ -158,28 +158,30 @@ def aprs_send(packet):
         logger.info('Packet sent to APRS-IS.')
 
 def dashboard_loc_write(call, lat, lon, time):
-    #try:
-    dash_entries = ast.literal_eval(os.popen('cat /tmp/gps_data_user_loc.txt').read())
-   # except:
-    #    dash_entries = []
-    dash_entries.insert(0, {'call': call, 'lat': lat, 'lon': lon, 'time':time})
-    with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
-            user_loc_file.write(str(dash_entries[:15]))
-            user_loc_file.close()
-    logger.info('User location saved for dashboard')
-    #logger.info(dash_entries)
+    pass
+##    #try:
+##    dash_entries = ast.literal_eval(os.popen('cat /tmp/gps_data_user_loc.txt').read())
+##   # except:
+##    #    dash_entries = []
+##    dash_entries.insert(0, {'call': call, 'lat': lat, 'lon': lon, 'time':time})
+##    with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
+##            user_loc_file.write(str(dash_entries[:15]))
+##            user_loc_file.close()
+##    logger.info('User location saved for dashboard')
+##    #logger.info(dash_entries)
 
 def dashboard_bb_write(call, dmr_id, time, bulletin):
-    #try:
-    dash_bb = ast.literal_eval(os.popen('cat /tmp/gps_data_user_bb.txt').read())
-   # except:
-    #    dash_entries = []
-    dash_bb.insert(0, {'call': call, 'dmr_id': dmr_id, 'time': time, 'bulliten':bulletin})
-    with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
-            user_bb_file.write(str(dash_bb[:10]))
-            user_bb_file.close()
-    logger.info('User bulletin entry saved.')
-    #logger.info(dash_bb)
+    pass
+##    #try:
+##    dash_bb = ast.literal_eval(os.popen('cat /tmp/gps_data_user_bb.txt').read())
+##   # except:
+##    #    dash_entries = []
+##    dash_bb.insert(0, {'call': call, 'dmr_id': dmr_id, 'time': time, 'bulliten':bulletin})
+##    with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
+##            user_bb_file.write(str(dash_bb[:10]))
+##            user_bb_file.close()
+##    logger.info('User bulletin entry saved.')
+##    #logger.info(dash_bb)
 
 # Send email via SMTP function
 def send_email(to_email, email_subject, email_message):
@@ -1706,20 +1708,20 @@ if __name__ == '__main__':
             user_dict_file.write("{1: [{'call': 'N0CALL'}, {'ssid': ''}, {'icon': ''}, {'comment': ''}]}")
             user_dict_file.close()
     # Check to see if dashboard files exist
-    if Path('/tmp/gps_data_user_loc.txt').is_file():
-        pass
-    else:
-        Path('/tmp/gps_data_user_loc.txt').touch()
-        with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
-            user_loc_file.write("[]")
-            user_loc_file.close()
-    if Path('/tmp/gps_data_user_bb.txt').is_file():
-        pass
-    else:
-        Path('/tmp/gps_data_user_bb.txt').touch()
-        with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
-            user_bb_file.write("[]")
-            user_bb_file.close()
+##    if Path('/tmp/gps_data_user_loc.txt').is_file():
+##        pass
+##    else:
+##        Path('/tmp/gps_data_user_loc.txt').touch()
+##        with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
+##            user_loc_file.write("[]")
+##            user_loc_file.close()
+##    if Path('/tmp/gps_data_user_bb.txt').is_file():
+##        pass
+##    else:
+##        Path('/tmp/gps_data_user_bb.txt').touch()
+##        with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
+##            user_bb_file.write("[]")
+##            user_bb_file.close()
 
 
 

gps_data-SAMPLE.cfg

@@ -84,7 +84,7 @@ REPORT_CLIENTS: 127.0.0.1
 #   used.
 #
 [LOGGER]
-LOG_FILE: /tmp/gps_data.log
+LOG_FILE: ./gps_data.log
 LOG_HANDLERS: console-timed
 LOG_LEVEL: DEBUG
 LOG_NAME: HBlink3 GPS/Data

gps_data.py

@@ -151,28 +151,30 @@ def aprs_send(packet):
         logger.info('Packet sent to APRS-IS.')
 
 def dashboard_loc_write(call, lat, lon, time):
-    #try:
-    dash_entries = ast.literal_eval(os.popen('cat /tmp/gps_data_user_loc.txt').read())
-   # except:
-    #    dash_entries = []
-    dash_entries.insert(0, {'call': call, 'lat': lat, 'lon': lon, 'time':time})
-    with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
-            user_loc_file.write(str(dash_entries[:15]))
-            user_loc_file.close()
-    logger.info('User location saved for dashboard')
-    #logger.info(dash_entries)
+    pass
+##    #try:
+##    dash_entries = ast.literal_eval(os.popen('cat /tmp/gps_data_user_loc.txt').read())
+##   # except:
+##    #    dash_entries = []
+##    dash_entries.insert(0, {'call': call, 'lat': lat, 'lon': lon, 'time':time})
+##    with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
+##            user_loc_file.write(str(dash_entries[:15]))
+##            user_loc_file.close()
+##    logger.info('User location saved for dashboard')
+##    #logger.info(dash_entries)
 
 def dashboard_bb_write(call, dmr_id, time, bulletin):
-    #try:
-    dash_bb = ast.literal_eval(os.popen('cat /tmp/gps_data_user_bb.txt').read())
-   # except:
-    #    dash_entries = []
-    dash_bb.insert(0, {'call': call, 'dmr_id': dmr_id, 'time': time, 'bulliten':bulletin})
-    with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
-            user_bb_file.write(str(dash_bb[:10]))
-            user_bb_file.close()
-    logger.info('User bulletin entry saved.')
-    #logger.info(dash_bb)
+    pass
+##    #try:
+##    dash_bb = ast.literal_eval(os.popen('cat /tmp/gps_data_user_bb.txt').read())
+##   # except:
+##    #    dash_entries = []
+##    dash_bb.insert(0, {'call': call, 'dmr_id': dmr_id, 'time': time, 'bulliten':bulletin})
+##    with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
+##            user_bb_file.write(str(dash_bb[:10]))
+##            user_bb_file.close()
+##    logger.info('User bulletin entry saved.')
+##    #logger.info(dash_bb)
 
 # Send email via SMTP function
 def send_email(to_email, email_subject, email_message):
@@ -610,21 +612,21 @@ if __name__ == '__main__':
         with open("./user_settings.txt", 'w') as user_dict_file:
             user_dict_file.write("{1: [{'call': 'N0CALL'}, {'ssid': ''}, {'icon': ''}, {'comment': ''}]}")
             user_dict_file.close()
-    # Check to see if dashboard files exist
-    if Path('/tmp/gps_data_user_loc.txt').is_file():
-        pass
-    else:
-        Path('/tmp/gps_data_user_loc.txt').touch()
-        with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
-            user_loc_file.write("[]")
-            user_loc_file.close()
-    if Path('/tmp/gps_data_user_bb.txt').is_file():
-        pass
-    else:
-        Path('/tmp/gps_data_user_bb.txt').touch()
-        with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
-            user_bb_file.write("[]")
-            user_bb_file.close()
+##    # Check to see if dashboard files exist
+##    if Path('/tmp/gps_data_user_loc.txt').is_file():
+##        pass
+##    else:
+##        Path('/tmp/gps_data_user_loc.txt').touch()
+##        with open("/tmp/gps_data_user_loc.txt", 'w') as user_loc_file:
+##            user_loc_file.write("[]")
+##            user_loc_file.close()
+##    if Path('/tmp/gps_data_user_bb.txt').is_file():
+##        pass
+##    else:
+##        Path('/tmp/gps_data_user_bb.txt').touch()
+##        with open("/tmp/gps_data_user_bb.txt", 'w') as user_bb_file:
+##            user_bb_file.write("[]")
+##            user_bb_file.close()
     # CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
     parser = argparse.ArgumentParser()
     parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually gps_data.cfg)')

hblink-SAMPLE.cfg

@@ -84,7 +84,7 @@ REPORT_CLIENTS: 127.0.0.1
 #   used.
 #
 [LOGGER]
-LOG_FILE: /tmp/hblink.log
+LOG_FILE: ./hblink.log
 LOG_HANDLERS: console-timed
 LOG_LEVEL: DEBUG
 LOG_NAME: HBlink