Configuration help

[vk3xem]

Hello, I have installed Python on my Windows computer ran the pip install aprsd which appears to have worked but unable to run aprsd sample-config

What am I doing wrong?

[hemna]

Can you provide logs or screen shots please?

[vk3xem]

[hemna]

I don't run or use windows, so my help may be limited.

From what I can tell you can activate your windows python with running the activate command inside the venv bin directory:

.venv/bin/activate

source is a linux bash/sh command. windows doesn't have that so just run the activate command as listed above.

[hemna]

The standard way to install aprsd is as follows.

1. Create a python virtual environment.
2. Source the environment.
3. install aprsd

python -m venv .venv
source .venv/bin/activate
pip install aprsd

[vk3xem]

source .venv/bin/activate returns an error

[hemna]

please provide screen shots or copy/paste the entire workflow please. I can't help without more information of what's actually happening.

[vk3xem]

[vk3xem]

Still getting the same error message

[vk3xem]

There is no bin folder

[hemna]

ok I'm not sure what to do, since this is a windows environment. I'm completely unfamiliar.

Here is the official python documentation on creating venvs.
https://docs.python.org/3/library/venv.html

It looks like for windows there is a Scripts directory?

So try

.venv/Scripts/activate.bat

[vk3xem]

This is impossible, I don't know what else to do

[hemna]

If you are already in the .venv directory, you have to adjust your path when running the command. Be mindful of the directory that you are in when running commands providing the path to the command.

If you are already in .venv

Scripts/activate.bat

[hemna]

cd C:\PythonScripts\aprsd
.venv\Scripts\activate.bat
pip install aprsd
aprsd --help

[vk3xem]

That worked, what is the next step to configure the service?

[hemna]

You now generate the config file

aprsd sample-config > aprsd.conf

edit the aprsd.conf for what you are using aprsd for.

[vk3xem]

The aprsd.conf file is empty

[vk3xem]

[hemna]

This looks like a windows specific problem with python. Not much I can do about it without a windows machine to test on.

It looks like you are using python 3.12 ? I have no tested aprsd on that new of a version. The latest I have tested aprsd on is 3.10.

fwiw, here is an empty aprsd.conf that I generated locally for you.

[DEFAULT]

#
# From aprsd.conf
#

# Callsign to use for messages sent by APRSD (string value)
#callsign = <None>

# Enable saving of watch list, packet tracker between restarts.
# (boolean value)
#enable_save = true

# Save location for packet tracking files. (string value)
#save_location = /Users/I530566/.config/aprsd/

# Enable code tracing (boolean value)
#trace_enabled = false

# Units for display, imperial or metric (string value)
#units = imperial

# The wait period in seconds per Ack packet being sent.1 means 1 ack
# packet per second allowed.2 means 1 pack packet every 2 seconds
# allowed (integer value)
#ack_rate_limit_period = 1

# Wait period in seconds per non AckPacket being sent.2 means 1 packet
# every 2 seconds allowed.5 means 1 pack packet every 5 seconds
# allowed (integer value)
#msg_rate_limit_period = 2

# The number of seconds before a packet is not considered a duplicate.
# (integer value)
#packet_dupe_timeout = 300

# Comma separated list of enabled plugins for APRSD.To enable
# installed external plugins add them here.The full python path to the
# class name must be used (list value)
#enabled_plugins = aprsd.plugins.email.EmailPlugin,aprsd.plugins.fortune.FortunePlugin,aprsd.plugins.location.LocationPlugin,aprsd.plugins.ping.PingPlugin,aprsd.plugins.query.QueryPlugin,aprsd.plugins.time.TimePlugin,aprsd.plugins.weather.OWMWeatherPlugin,aprsd.plugins.version.VersionPlugin,aprsd.plugins.notify.NotifySeenPlugin


[admin]

#
# From aprsd.conf
#

# Enable the Admin Web Interface (boolean value)
#web_enabled = false

# The ip address to listen on (IP address value)
#web_ip = 0.0.0.0

# The port to listen on (port value)
# Minimum value: 0
# Maximum value: 65535
#web_port = 8001

# The admin user for the admin web interface (string value)
#user = admin

# Admin interface password (string value)
#password = password


[aprs_fi]

#
# From aprsd.conf
#

# Get the apiKey from your aprs.fi account here:http://aprs.fi/account
# (string value)
#apiKey = <None>


[aprs_network]

#
# From aprsd.conf
#

# Set enabled to False if there is no internet connectivity.This is
# useful for a direwolf KISS aprs connection only. (boolean value)
#enabled = true

# APRS Username (string value)
#login = NOCALL

# APRS Password Get the passcode for your callsign here:
# https://apps.magicbug.co.uk/passcode (string value)
#password = <None>

# The APRS-IS hostname (host address value)
#host = noam.aprs2.net

# APRS-IS port (port value)
# Minimum value: 0
# Maximum value: 65535
#port = 14580


[aprsd_mqtt_plugin]

#
# From aprsd_mqtt_plugin.conf
#

# Enable the plugin? (boolean value)
#enabled = false

# The hostname/ip address of the mqtt server (string value)
#host_ip = <None>

# The port to of the MQTT server (integer value)
#host_port = 1883

# The mqtt username to use (string value)
#user = <None>

# the mqtt password (string value)
#password = <None>

# The MQTT Topic to subscribe for messages (string value)
#topic = aprsd/packet


[avwx_plugin]

#
# From aprsd.conf
#

# avwx-api is an opensource project that hasa hosted service here:
# https://avwx.rest/You can launch your own avwx-api in a containerby
# cloning the githug repo here:https://github.com/avwx-rest/AVWX-API
# (string value)
#apiKey = <None>

# The base url for the avwx API.  If you are hosting your ownHere is
# where you change the url to point to yours. (string value)
#base_url = https://avwx.rest


[email_plugin]

#
# From aprsd.conf
#

# (Required) Callsign to validate for doing email commands.Only this
# callsign can check email. This is also where the email notifications
# for new emails will be sent. (string value)
#callsign = <None>

# Enable the Email plugin? (boolean value)
#enabled = false

# Enable the Email plugin Debugging? (boolean value)
#debug = false

# Login username/email for IMAP server (string value)
#imap_login = <None>

# Login password for IMAP server (string value)
#imap_password = <None>

# Hostname/IP of the IMAP server (hostname value)
#imap_host = <None>

# Port to use for IMAP server (port value)
# Minimum value: 0
# Maximum value: 65535
#imap_port = 993

# Use SSL for connection to IMAP Server (boolean value)
#imap_use_ssl = true

# Login username/email for SMTP server (string value)
#smtp_login = <None>

# Login password for SMTP server (string value)
#smtp_password = <None>

# Hostname/IP of the SMTP server (hostname value)
#smtp_host = <None>

# Port to use for SMTP server (port value)
# Minimum value: 0
# Maximum value: 65535
#smtp_port = 465

# Use SSL for connection to SMTP Server (boolean value)
#smtp_use_ssl = true

# List of email shortcuts for checking/sending email For Exmaple:
# [email protected],[email protected]
# Means use 'wb' to send an email to [email protected] (list value)
#email_shortcuts = <None>


[fake_client]

#
# From aprsd.conf
#

# Enable fake client connection. (boolean value)
#enabled = false


[kiss_serial]

#
# From aprsd.conf
#

# Enable Serial KISS interface connection. (boolean value)
#enabled = false

# Serial Device file to use.  /dev/ttyS0 (string value)
#device = <None>

# The Serial device baud rate for communication (integer value)
#baudrate = 9600

# The APRS path to use for wide area coverage. (list value)
#path = WIDE1-1,WIDE2-1


[kiss_tcp]

#
# From aprsd.conf
#

# Enable Serial KISS interface connection. (boolean value)
#enabled = false

# The KISS TCP Host to connect to. (host address value)
#host = <None>

# The KISS TCP/IP network port (port value)
# Minimum value: 0
# Maximum value: 65535
#port = 8001

# The APRS path to use for wide area coverage. (list value)
#path = WIDE1-1,WIDE2-1


[location_plugin]

#
# From aprsd.conf
#

# The geopy geocoder to use.  Default is Nominatim.See
# https://geopy.readthedocs.io/en/stable/#module-geopy.geocodersfor
# more information. (string value)
# Possible values:
# ArcGIS - <No description provided>
# AzureMaps - <No description provided>
# Baidu - <No description provided>
# Bing - <No description provided>
# GoogleV3 - <No description provided>
# HERE - <No description provided>
# Nominatim - <No description provided>
# OpenCage - <No description provided>
# TomTom - <No description provided>
# USGov - <No description provided>
# What3Words - <No description provided>
# Woosmap - <No description provided>
#geopy_geocoder = Nominatim

# The user agent to use for the Nominatim geocoder.See
# https://geopy.readthedocs.io/en/stable/#module-geopy.geocodersfor
# more information. (string value)
#user_agent = APRSD

# The username to use for the ArcGIS geocoder.See
# https://geopy.readthedocs.io/en/latest/#arcgisfor more
# information.Only used for the ArcGIS geocoder. (string value)
#arcgis_username = <None>

# The password to use for the ArcGIS geocoder.See
# https://geopy.readthedocs.io/en/latest/#arcgisfor more
# information.Only used for the ArcGIS geocoder. (string value)
#arcgis_password = <None>

# The subscription key to use for the AzureMaps geocoder.See
# https://geopy.readthedocs.io/en/latest/#azuremapsfor more
# information.Only used for the AzureMaps geocoder. (string value)
#azuremaps_subscription_key = <None>

# The API key to use for the Baidu geocoder.See
# https://geopy.readthedocs.io/en/latest/#baidufor more
# information.Only used for the Baidu geocoder. (string value)
#baidu_api_key = <None>

# The API key to use for the Bing geocoder.See
# https://geopy.readthedocs.io/en/latest/#bingfor more
# information.Only used for the Bing geocoder. (string value)
#bing_api_key = <None>

# The API key to use for the Google geocoder.See
# https://geopy.readthedocs.io/en/latest/#googlev3for more
# information.Only used for the Google geocoder. (string value)
#google_api_key = <None>

# The API key to use for the HERE geocoder.See
# https://geopy.readthedocs.io/en/latest/#herefor more
# information.Only used for the HERE geocoder. (string value)
#here_api_key = <None>

# The API key to use for the OpenCage geocoder.See
# https://geopy.readthedocs.io/en/latest/#opencagefor more
# information.Only used for the OpenCage geocoder. (string value)
#opencage_api_key = <None>

# The API key to use for the TomTom geocoder.See
# https://geopy.readthedocs.io/en/latest/#tomtomfor more
# information.Only used for the TomTom geocoder. (string value)
#tomtom_api_key = <None>

# The API key to use for the What3Words geocoder.See
# https://geopy.readthedocs.io/en/latest/#what3wordsfor more
# information.Only used for the What3Words geocoder. (string value)
#what3words_api_key = <None>

# The API key to use for the Woosmap geocoder.See
# https://geopy.readthedocs.io/en/latest/#woosmapfor more
# information.Only used for the Woosmap geocoder. (string value)
#woosmap_api_key = <None>


[logging]

#
# From aprsd.conf
#

# File to log to (string value)
#logfile = <None>

# Log file format, unless rich_logging enabled. (string value)
#logformat = <green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <yellow>{thread.name: <18}</yellow> | <level>{level: <8}</level> | <level>{message}</level> | <cyan>{name}</cyan>:<cyan>{function:}</cyan>:<magenta>{line:}</magenta>

# Log level for logging of events. (string value)
# Possible values:
# CRITICAL - <No description provided>
# ERROR - <No description provided>
# WARNING - <No description provided>
# INFO - <No description provided>
# DEBUG - <No description provided>
#log_level = INFO


[owm_weather_plugin]

#
# From aprsd.conf
#

# OWMWeatherPlugin api key to OpenWeatherMap's API.This plugin uses
# the openweathermap API to fetchlocation and weather information.To
# use this plugin you need to get an openweathermapaccount and
# apikey.https://home.openweathermap.org/api_keys (string value)
#apiKey = <None>


[query_plugin]

#
# From aprsd.conf
#

# The Ham callsign to allow access to the query plugin from RF.
# (string value)
#callsign = <None>


[rpc_settings]

#
# From aprsd.conf
#

# Enable RPC calls (boolean value)
#enabled = true

# The ip address to listen on (string value)
#ip = localhost

# The port to listen on (port value)
# Minimum value: 0
# Maximum value: 65535
#port = 18861

# Magic word to authenticate requests between client/server (string
# value)
#magic_word = CHANGEME!!!


[watch_list]

#
# From aprsd.conf
#

# Enable the watch list feature.  Still have to enable the correct
# plugin.  Built-in plugin to use is aprsd.plugins.notify.NotifyPlugin
# (boolean value)
#enabled = false

# Callsigns to watch for messsages (list value)
#callsigns = <None>

# The Ham Callsign to send messages to for watch list alerts. (string
# value)
#alert_callsign = <None>

# The number of packets to store. (integer value)
#packet_keep_count = 10

# Time to wait before alert is sent on new message for users in
# callsigns. (integer value)
#alert_time_seconds = 3600


[webchat]

#
# From aprsd.conf
#

# The ip address to listen on (IP address value)
#web_ip = 0.0.0.0

# The port to listen on (port value)
# Minimum value: 0
# Maximum value: 65535
#web_port = 8001

# Latitude for the GPS Beacon button.  If not set, the button will not
# be enabled. (string value)
#latitude = <None>

# Longitude for the GPS Beacon button.  If not set, the button will
# not be enabled. (string value)
#longitude = <None>

[vk3xem]

Thank you for your guidance and help.

[hemna]

no problem. I have installed python 3.12 locally and have been able to reproduce your problem. working on a fix for it.

[vk3xem]

That's great, do I remove the # on the selected lines I alter?

[hemna]

yes, the # denotes a commented out line. Just remove the # and edit the value of the field.

[hemna]

I just put a fix in on master that will fix your problem for python 3.12. if you want to try running against the latest code in the master branch, which may be unstable.

0ca5cee

If you are daring and want to try the latest unsupported and untested:
This won't interfere with your previous install of aprsd which is from pypi. This will install from github and the latest code in master branch, which has my fix in it...

cd c:\PythonScripts\aprsd
python -m venv .master
.master\Scripts\activate.bat
pip install git+https://github.com/craigerl/aprsd.git
aprsd sample-config > aprsd.conf