agent_essentials

Essentials for programming agents

Components:

• MQTT Broker Wrapper
• Console beautifier
• Agents

MQTT Broker Wrapper

The Broker wrapper handles the connecting of agents to a given MQTT broker.

Console beautifier

Support functions for console output

Features:

• Console.fprint() Generic fprint with timestamp included.
• Console.Debug() Debug releated messages. (add source="function name or file")
• Console.Info() Everything not importand but provides info.
• Console.Warning() Problems or info that should be handled
• Console.Error() Display Explicit error messages (critial)
• Console.Notice() A message received or transmitted eg. operational info
• Console.info_spinner() Same as the Info() function, but with a spinner -> '/ - \ |'

The output level can be dynamically changed. See the code for examples

Wrapper functions:

• Timer() (@timer) This wrapper function allows for easy timing of the function call duration.

Agents

An agent links a function call to a topic. When received a given function can be automatically called.
Also the agent can do a 'delayed' call. this way a period of data accumulation can take place.
For example a sensor publishes 10 different values, it can be usefull wait for n seconds before processing the data.
As it can be that all new values are needed to perform an operation the delayed method makes this possible.

Change Log 📃

Version 1.3.5

@05032024 ^MBRS

• agents.py now has support for configuration storage
  • Default configuration
  • Specific configuration
  • (True) configuration (Merged version of Defaults and Specific)

Version 1.3.4

@01032024 ^MB

• agents.py now has support for attributes:
  • Adding
  • Updating
  • Store to file
  • Restore from file

Version 1.3.2

@02022023 ^MB

• console.py:info_spinner() can now show the cycle it is in. Add [cycle] to the text string.
• Added more comments to the code.

Version 1.2.2

@09122022 ^MB

• agents.py:Broker.__init__() now has improved Client_id generation.
  The host name + a random number (1..999) is now used if no explicit clientID is given.
• Minor change to the readme file.

Version 1.2.1 ✔️

@08122022 ^MB

• Release v1.2.1
• Added a prepare script. It should be run prior to any 'push tag' to automatically include the tag version in the broker settings. See: Tip 'n tricks

Version 1.2.0

@07122022 ^MB

• Added example project
• Added disconnect on credentials check.

Version 1.1.2 ✔️

@07122022 ^MB

• Release v1.1.2
• Minor changes
• First release version.

Version 1.1.0

@07122022 ^MB

• Added info_spinner
• Changed the spinner text layout to [spinner] [text] this look better
• Added option to change the width of the timestamp field
• Added option to change the width of the title field
• Added a notice line.
• Release candidate.

Version 1.0.0

@30112021 ^MB

• Added documentation and set this as the Version 1.0.0
• Added Version variable to the Agent and Broker.

Tips 'n Tricks

1. Get all git submodules:

   'git submodule update --init --recursive'
   

2. Install all the required python modules:

   $ pip install -r requirements.txt
   

3. Push a new tag / version:

   $ git tag v1.2.3
   $ bash prepare.sh
   $ git commit -a
   $ git push
   $ git push origin v1.2.3