diff --git a/README.md b/README.md
index ac081d173a3765d4e92a86f3e067fb1f11f7b018..cbd743f609d8e03409de886a9cd9b5b41881d1ec 100644
--- a/README.md
+++ b/README.md
@@ -25,47 +25,53 @@
- [**Bibliography**](#bibliography)
-## **Definition**
+## **Introduction**
+
+### **Definition**
MAS (multi-agent system):
> A multi-agent system (MAS or "self-organized system") is a computerized system composed of multiple interacting intelligent agents.
> Multi-agent systems can solve problems that are difficult or impossible for an individual agent or a monolithic system to solve.
> Intelligence may include methodic, functional, procedural approaches, algorithmic search or reinforcement learning.
-## **Goal**
-### **Subject**
+### **Context**
-> The goal of this project is to produce a wab-app to supervise remotly experiments distributed on multiple device for researcher in MAS of the IRIT. The application need to give in real time information to the user of the state of each devise / agent (activity, result..). The general architecture of the system is in 3 part :
-> 1. Some devises that can work (Raspberry pi 3b)
-> 2. A control device collecting information (server)
-> 3. An application that can show the server information according to the user need.
->
-> This project will be focused on the devedloppement of a system that can distribute a SMA defnie by AMAK on multiple raspberry PI. Once distributed, the server can start and stop the experiment. The 2nd goal of this project is to build a network architecure between those raspberry so each Agent can communicate between them and with the manager.
+The SMAC team in Irit developed a tool called Amak that help scientist to develop MAS system in Java.
+The wished to extend the tool in multiple programing language,
+last year I participated in the conception and development of Py-AMAK (Python) during my internship,
+an extension of AMAK (Java). Other version of AMAK exist in C# and C++.
-### **Context**
+This year the goal of the internship is to develop IoTAMAK, that will extend the application of Py-AMAK to use network and multiple device.
-Last year I participated in the conception and development of Py-AMAK (Python) during my internship, an extention of AMAK (Java) a framework that helps developper to produce MAS system and visualize the result.
+### **Problem and objective**
-This year the goal of the intership is to developp IoTAMAK, that will extend the application of Py-AMAK to use network and multiple device.
+So far all Amak system can only be used to simulate MAS system, but they canno't be use with an agent that would exist in our world.
+IoTAMAK goal to connect any devices to the system as agent(s) and use the network to communicate.
-Notable diference between IoTAMAK and Py-AMAK on the interface :
+Notable difference between IoTAMAK and Py-AMAK on the interface :
* The structure need to be done in a more pythonic way (no getter/setter, no public/private attribute)
* The UI need to be a web app powered by a server
-### **Constraint**
-
-**Language :** Python
+> The goal of this project is to produce a wab-app to supervise remotely experiments distributed on multiple device for researcher in MAS of the IRIT. The application need to give in real time information to the user of the state of each devise / agent (activity, result..). The general architecture of the system is in 3 part :
+> 1. Some devises that can work (Raspberry pi 3b)
+> 2. A control device collecting information (server)
+> 3. An application that can show the server information according to the user need.
+>
+> This project will be focused on the development of a system that can distribute a SMA define by AMAK on multiple raspberry PI. Once distributed, the server can start and stop the experiment. The 2nd goal of this project is to build a network architecure between those raspberry so each Agent can communicate between them and with the manager.
-The system need to follow MVC design patern, this mean that the core could work on his own, and a UI is not require.
+Constraint :
+ * Communication between agent : MQTT
+ * Language : Python
+ * Follow the MVC patern to separate the UI with the core system, this mean that the core could work on his own, and a UI is not require.
-## **Solution**
+### **Solution**
-The project will be splited into 2 parts :
+The project will be split into 2 parts :
* IoTAMAK-core : a python module (that can be easily installed with pip) that provide all the basic method required to build a MAS experiment
- * IoTAMAK UI : a django based server that can interact with any experiment developped with IoTAMAK-core.
+ * IoTAMAK UI : a django based server that can interact with any experiment developed with IoTAMAK-core.
-## **Project managment**
+### **Project management**
Meeting : weekly
@@ -78,14 +84,14 @@ Tool :
### **IoTAMAK core**
-The classes that the developper will interact with (Agent / Amas / Environment) need to be very similar to the Py-AMAK one, this is why the class looks very similar.
+The classes that the developer will interact with (Agent / Amas / Environment) need to be very similar to the Py-AMAK one, this is why the class looks very similar.
#### **Code structure** :
-In AMAK a SMA is composed of 4 main strucure :
- * Scheduler : it's role is to make sure that everything is working in the right order, it's also play a huge role with the interface between the UI and the experiment, being able to pause it, or closing everyting.
+In AMAK a SMA is composed of 4 main structure :
+ * Scheduler : it's a role is to make sure that everything is working in the right order, it's also play a huge role with the interface between the UI and the experiment, being able to pause it, or closing everyting.
* Agent : an agent can have various comportment that need to be define
- * Amas : it's a superstructure, above the agents that provide conviniant way to add, remove or make communication between agents
+ * Amas : it's a superstructure, above the agents that provide convenient way to add, remove or make communication between agents
* Environment : a place where the agent live.
```mermaid
diff --git a/dist/iotAmak-0.0.6-py3-none-any.whl b/dist/iotAmak-0.0.6-py3-none-any.whl
new file mode 100644
index 0000000000000000000000000000000000000000..1d9c5e36f46469723f6d11e3db73b8d1dd968ae9
Binary files /dev/null and b/dist/iotAmak-0.0.6-py3-none-any.whl differ
diff --git a/iotAmak/agent.py b/iotAmak/agent.py
index bbaaf26524fd083c4c2855de6e3c837f3e5dfc4f..8ccb58e98cad2db0dbdaf60962f57b54ee0b4af7 100644
--- a/iotAmak/agent.py
+++ b/iotAmak/agent.py
@@ -21,19 +21,19 @@ class Agent(Schedulable):
def __init__(self, arguments: str) -> None:
- arguments = json.loads(arguments)
+ arguments: Dict = json.loads(arguments)
broker_ip: str = arguments.get("broker_ip")
identifier: int = int(arguments.get("identifier"))
seed: int = int(arguments.get("seed"))
+ broker_username: str = str(arguments.get("broker_username"))
+ broker_password: str = str(arguments.get("broker_password"))
self.id: int = identifier
random.seed(seed + 10 + self.id)
- print(random.random())
-
- Schedulable.__init__(self, broker_ip, "Agent" + str(self.id))
+ Schedulable.__init__(self, broker_ip, "Agent" + str(self.id), broker_username, broker_password)
self.subscribe("scheduler/agent/wakeup", self.wake_up)
@@ -58,8 +58,7 @@ class Agent(Schedulable):
put the metric in a list that will be rad during on_perceive
param message: metric (dict) of the neighbor
"""
- print(message.payload.decode("utf-8"))
- result = literal_eval(message.payload.decode("utf-8"))
+ result: Dict = literal_eval(message.payload.decode("utf-8"))
self.next_neighbors.append(result)
def log(self, message: str) -> None:
diff --git a/iotAmak/amas.py b/iotAmak/amas.py
index 8d815789290df0a47a4c3425ea976966d06739ac..d335985a42748eb028d8a15a840c78307adadfd2 100644
--- a/iotAmak/amas.py
+++ b/iotAmak/amas.py
@@ -25,21 +25,21 @@ class Amas(Schedulable, SSHClient):
arguments = json.loads(arguments)
- broker_ip: str = arguments.get("broker_ip")
+ self.broker_ip: str = arguments.get("broker_ip")
clients: str = arguments.get("clients")
- seed: int = int(arguments.get("seed"))
+ self.seed: int = int(arguments.get("seed"))
+ self.broker_username: str = str(arguments.get("broker_username"))
+ self.broker_password: str = str(arguments.get("broker_password"))
+ iot_path: str = str(arguments.get("iot_path"))
- random.seed(seed)
+ random.seed(self.seed)
- Schedulable.__init__(self, broker_ip, "Amas")
+ Schedulable.__init__(self, self.broker_ip, "Amas", self.broker_username, self.broker_password)
true_client = [RemoteClient(i.get("hostname"), i.get("user"), i.get("password")) for i in literal_eval(clients)]
- SSHClient.__init__(self, true_client)
+ SSHClient.__init__(self, true_client, iot_path)
- self.seed: int = seed
-
- self.broker_ip: str = broker_ip
self.subscribe("scheduler/schedulable/wakeup", self.wake_up)
self.next_id: int = 0
@@ -78,10 +78,16 @@ class Amas(Schedulable, SSHClient):
if args is None:
args = []
- arg_dict = {"broker_ip": str(self.broker_ip), "seed": self.seed, "identifier": self.next_id}
+ arg_dict = {
+ "broker_ip": str(self.broker_ip),
+ "seed": self.seed,
+ "identifier": self.next_id,
+ "broker_username": self.broker_username,
+ "broker_password": self.broker_password
+ }
command = "nohup python "
- command += "\'Desktop/mqtt_goyon/example/" + experience_name + "/"+agent_name+"\' \'"
+ command += "\'" + self.iot_path + experience_name + "/"+agent_name+"\' \'"
command += json.dumps(arg_dict) + "\' "
for arg in args:
command += str(arg) + " "
@@ -97,7 +103,7 @@ class Amas(Schedulable, SSHClient):
else:
have_found = False
for i_client in range(len(self.clients)):
- if self.clients[i_client].hostname == i_client:
+ if self.clients[i_client].hostname == client_ip:
self.agents_cmd[i_client].append(Cmd(command))
have_found = True
break
@@ -105,7 +111,6 @@ class Amas(Schedulable, SSHClient):
self.agents_cmd[0].append(Cmd(command))
self.subscribe("agent/" + str(self.next_id) + "/metric", self.agent_metric)
- self.subscribe("agent/" + str(self.next_id) + "/log", self.agent_log)
self.client.publish("amas/agent/new", self.next_id)
self.next_id += 1
@@ -115,6 +120,7 @@ class Amas(Schedulable, SSHClient):
Method used to start new agent trough ssh
"""
for i_client in range(len(self.clients)):
+ print(" Ip : ", self.clients[i_client].hostname)
self.run_cmd(i_client, self.agents_cmd[i_client])
print("Amas, push agent done")
@@ -124,12 +130,6 @@ class Amas(Schedulable, SSHClient):
"""
self.publish("amas/agent/" + str(id_agent1) + "/neighbor", str(self.agents_metric[id_agent2]))
- def agent_log(self, client, userdata, message) -> None:
- """
- Called when the amas receive a log from any agent, print it in stdout
- """
- print("[Log] " + str(message.payload.decode("utf-8")) + " on topic " + message.topic)
-
def agent_metric(self, client, userdata, message) -> None:
"""
Called when the amas receive new metrics from any agent
diff --git a/iotAmak/communicating_agent.py b/iotAmak/communicating_agent.py
index 17521a222380ff33b694988d21d5861cc06aeaaf..0600ea957d83888b181750ec2b1389e413a3835f 100644
--- a/iotAmak/communicating_agent.py
+++ b/iotAmak/communicating_agent.py
@@ -1,6 +1,7 @@
import json
import pathlib
import sys
+from ast import literal_eval
from typing import List, Any
sys.path.insert(0, str(pathlib.Path(__file__).parent))
@@ -17,13 +18,13 @@ class CommunicatingAgent(Agent):
def __init__(self, arguments: str) -> None:
self.mailbox: List[Mail] = []
Agent.__init__(self, arguments)
- self.subscribe("mail", self.receive_mail)
+ self.subscribe("agent/" + str(self.id) + "/mail", self.receive_mail)
def receive_mail(self, client, userdata, message) -> None:
"""
Called when the agent receive a new message
"""
- raw = json.loads(message)
+ raw = literal_eval(message.payload.decode("utf-8"))
self.mailbox.append(Mail(raw.get("id"), raw.get("cycle"), raw.get("payload")))
def send_mail(self, agent_id: int, payload: Any) -> None:
@@ -34,4 +35,29 @@ class CommunicatingAgent(Agent):
"""
new_mail = {"id": self.id, "cycle": self.nbr_cycle, "payload": payload}
- self.publish("agent/" + str(agent_id) + "/mail", json.dumps(new_mail))
+ self.client.publish("agent/" + str(agent_id) + "/mail", json.dumps(new_mail))
+
+ def next_mail(self) -> Mail:
+ """
+ Convenient method to use to go through the mailbox
+ :return: the next mail, if no mail are in the mailbox, return None. Remove the mail from the mailbox
+ """
+ if len(self.mailbox) == 0:
+ return None
+ return self.mailbox.pop(0)
+
+ def put_back(self, mail: Mail) -> None:
+ """
+ Put the mail at the end of the mailbox
+ """
+ self.mailbox.append(mail)
+
+ def put_front(self, mail: Mail) -> None:
+ """
+ put the mail in the front of the mailbox
+ """
+ self.mailbox = [mail] + self.mailbox
+
+
+
+
diff --git a/iotAmak/environment.py b/iotAmak/environment.py
index 16910585724dcee7335f0be98abbc537dcacfd25..b054cbce1c02e029460c69fdc97c85de139da7db 100644
--- a/iotAmak/environment.py
+++ b/iotAmak/environment.py
@@ -22,10 +22,12 @@ class Environment(Schedulable):
broker_ip: str = arguments.get("broker_ip")
seed: int = int(arguments.get("seed"))
+ broker_username: str = str(arguments.get("broker_username"))
+ broker_password: str = str(arguments.get("broker_password"))
random.seed(seed + 1)
- Schedulable.__init__(self, broker_ip, "Env")
+ Schedulable.__init__(self, broker_ip, "Env", broker_username, broker_password)
self.subscribe("scheduler/schedulable/wakeup", self.wake_up)
diff --git a/iotAmak/scheduler.py b/iotAmak/scheduler.py
index 9f8994154dc0c4f08461be181219f8db036a1804..19e21ead3e01ca697db0c230f40a2dd5d5abcf2e 100644
--- a/iotAmak/scheduler.py
+++ b/iotAmak/scheduler.py
@@ -17,12 +17,12 @@ class Scheduler(Schedulable):
Scheduler class, it's role is to make sure the amas, the env and all the agents stay in sync
"""
- def __init__(self, broker_ip: str) -> None:
+ def __init__(self, broker_ip: str, broker_username: str, broker_password: str) -> None:
- Schedulable.__init__(self, broker_ip, "Scheduler")
+ Schedulable.__init__(self, broker_ip, "Scheduler", broker_username, broker_password)
self.paused = True
- self.nbr_agent = 0
+ self.nbr_agent: int = 0
self.subscribe("amas/agent/new", self.update_nbr_agent)
self.subscribe("amas/action_done", self.update_schedulable)
self.subscribe("env/action_done", self.update_schedulable)
diff --git a/iotAmak/tool/confi_reader.py b/iotAmak/tool/confi_reader.py
index ca9b3448bd0e2015bec66bfdfa067ccd5da25e5a..5070707f8f3489928519b3870e7632e9d5503888 100644
--- a/iotAmak/tool/confi_reader.py
+++ b/iotAmak/tool/confi_reader.py
@@ -9,10 +9,10 @@ from iotAmak.tool.remote_client import RemoteClient
def read_ssh(path):
with open(path, 'r', encoding='utf-8') as f:
- dict = json.load(f)
+ ssh_dict = json.load(f)
res = []
- for client in dict.get("clients_ssh"):
+ for client in ssh_dict.get("clients_ssh"):
res.append(RemoteClient(
hostname=client.get("hostname"),
user=client.get("user"),
diff --git a/iotAmak/tool/mail.py b/iotAmak/tool/mail.py
index cda88928bb64eff6bbab41ceb5f766d85521e3f6..ab070080e50c600c3a038f0778cc03400e2a1d0a 100644
--- a/iotAmak/tool/mail.py
+++ b/iotAmak/tool/mail.py
@@ -2,6 +2,9 @@ from typing import Any
class Mail:
+ """
+ Mail class used by the communicating agent
+ """
def __init__(self, sender_id: int, date: int, payload: Any) -> None:
diff --git a/iotAmak/tool/mqtt_client.py b/iotAmak/tool/mqtt_client.py
index 3c5289ac766e68c2acd355966455da4c258caf3d..9ee4e9136da4c081e68ffb470591bfa2e95f841e 100644
--- a/iotAmak/tool/mqtt_client.py
+++ b/iotAmak/tool/mqtt_client.py
@@ -11,9 +11,9 @@ class MqttClient:
Base class to any instance that need to interact with the broker
"""
- def __init__(self, broker_ip: str, client_id: str):
+ def __init__(self, broker_ip: str, client_id: str, broker_username: str, broker_password: str):
self.client: Client = Client(client_id=client_id)
- self.client.username_pw_set(username="goyon", password="mosquitto")
+ self.client.username_pw_set(username=broker_username, password=broker_password)
self.client.connect(host=broker_ip)
self.client.loop_start()
diff --git a/iotAmak/tool/schedulable.py b/iotAmak/tool/schedulable.py
index d8c4f1cb3eceec079d1f04fea0a97cc119d9abb3..0a2730446df42961b68d420fbac4134879f3ea71 100644
--- a/iotAmak/tool/schedulable.py
+++ b/iotAmak/tool/schedulable.py
@@ -1,7 +1,6 @@
"""
Tool class that implement basic interaction that help to finish processes
"""
-from time import sleep
import sys
import pathlib
@@ -17,8 +16,8 @@ class Schedulable(MqttClient):
Base class for Agent/Amas/Env/scheduler
"""
- def __init__(self, broker_ip: str, client_id: str):
- MqttClient.__init__(self, broker_ip, client_id)
+ def __init__(self, broker_ip: str, client_id: str, broker_username: str, broker_password: str):
+ MqttClient.__init__(self, broker_ip, client_id, broker_username, broker_password)
self.exit_bool: bool = False
self.subscribe("ihm/exit", self.exit_procedure)
diff --git a/iotAmak/tool/ssh_client.py b/iotAmak/tool/ssh_client.py
index 83f1f76df0451905b74dd0fa72cc458c5130ebf8..858df6dccd0c6336ba77046e2a76fe2f8e952a8c 100644
--- a/iotAmak/tool/ssh_client.py
+++ b/iotAmak/tool/ssh_client.py
@@ -1,4 +1,3 @@
-
from typing import List
import paramiko
@@ -23,8 +22,9 @@ class Cmd:
class SSHClient:
- def __init__(self, clients: List[RemoteClient]):
+ def __init__(self, clients: List[RemoteClient], iot_path: str):
self.clients = clients
+ self.iot_path = iot_path
def run_cmd(self, client: int, cmd: list, repeat: bool = False) -> list[str]:
ret = []
@@ -53,20 +53,22 @@ class SSHClient:
transport = paramiko.Transport((client.hostname, 22))
transport.connect(username=client.user, password=client.password)
sftp = MySFTPClient.from_transport(transport)
- sftp.mkdir("Desktop/mqtt_goyon/example/" + experiment_name, ignore_existing=True)
+ sftp.mkdir(self.iot_path + experiment_name, ignore_existing=True)
sftp.put_dir(
path_to_experiment,
- "Desktop/mqtt_goyon/example/" + experiment_name
+ self.iot_path + experiment_name
)
sftp.close()
+
class MySFTPClient(paramiko.SFTPClient):
def put_dir(self, source, target):
- ''' Uploads the contents of the source directory to the target path. The
- target directory needs to exists. All subdirectories in source are
- created under target.
- '''
+ """
+ Uploads the contents of the source directory to the target path. The
+ target directory needs to exists. All subdirectories in source are
+ created under target.
+ """
for item in os.listdir(source):
if os.path.isfile(os.path.join(source, item)):
self.put(os.path.join(source, item), '%s/%s' % (target, item))
@@ -80,7 +82,9 @@ class MySFTPClient(paramiko.SFTPClient):
print(os.path.join(source, item))
def mkdir(self, path, mode=511, ignore_existing=False):
- ''' Augments mkdir by adding an option to not fail if the folder exists '''
+ """
+ Augments mkdir by adding an option to not fail if the folder exists
+ """
try:
super(MySFTPClient, self).mkdir(path, mode)
except IOError:
diff --git a/setup.py b/setup.py
index ee51db169713c8716041103be216a50fa8e0246a..c88411713ae214b66f3a100c867e7e5b73574f30 100644
--- a/setup.py
+++ b/setup.py
@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
setup(
name='iotAmak',
packages=find_packages(),
- version='0.0.5',
+ version='0.0.6',
description='AmakFramework in python',
author='SMAC - GOYON Sebastien',
install_requires=[