aprsd/examples/plugins/example_plugin.py

import logging

from aprsd import packets, plugin

LOG = logging.getLogger("APRSD")


class HelloPlugin(plugin.APRSDRegexCommandPluginBase):
    """Hello World."""

    version = "1.0"
    # matches any string starting with h or H
    command_regex = "^[hH]"
    command_name = "hello"

    def process(self, packet: packets.MessagePacket):
        LOG.info("HelloPlugin")
        reply = f"Hello '{packet.from_call}'"
        return reply
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00			`import logging`

updated plugin example 2025-01-07 10:22:01 -05:00			`from aprsd import packets, plugin`
Use Gray instead of Black for code formatting. The Black code formatter sucks with respect to function declarations with a lot of params. Completely unreadable. 2021-08-23 12:14:19 -04:00
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00			`LOG = logging.getLogger("APRSD")`


Change RX packet processing to enqueu This changes the RX thread to send the packet into a queue instead of starting a new thread for every packet. 2022-12-18 08:52:58 -05:00			`class HelloPlugin(plugin.APRSDRegexCommandPluginBase):`
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00			`"""Hello World."""`

			`version = "1.0"`
			`# matches any string starting with h or H`
			`command_regex = "^[hH]"`
Fixed the usage string after plugins introduced This patch fixes the Usage string for a call message that isn't matched by any plugin. Plugin object now must impleent a 'command_name' attribute that is the usage string for that plugin. 2020-12-13 21:31:01 -05:00			`command_name = "hello"`
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00
updated plugin example 2025-01-07 10:22:01 -05:00			`def process(self, packet: packets.MessagePacket):`
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00			`LOG.info("HelloPlugin")`
Change RX packet processing to enqueu This changes the RX thread to send the packet into a queue instead of starting a new thread for every packet. 2022-12-18 08:52:58 -05:00			`reply = f"Hello '{packet.from_call}'"`
Created plugin.py for Command Plugins This patch adds the new APRSD Command Plugin architecture. All Comand plugins must implement the same object API, which includes plugin object is subclass of APRSDPluginBase version attribute command_regex attribute command method When an APRS command is detected, then the regex is run against the command. If the command_regex matches, then the plugin's command() method will be called. If the command() method returns a string, then that string is sent as a reply to the APRS caller. A new aprs.yml config section is added to support selecting which plugins to enable. If you want all plugins enabled, then omit "enabled_plugins" entirely from the aprs section of the config. To load custom plugins: 1) create a directory with an __init__.py file 2) Add a plugin.py file that contains your plugin Look at the exmaples directory for an example plugin. 2020-12-12 15:53:06 -05:00			`return reply`