05b_miniTractor_shield.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Mini Tractor ServiceRequest\n",
    "This is a KWH HMI which allows to request the mini tractor's *AcceptsShieldCommands* service. The AcceptsShieldCommands service is a fml40 service which moves the shield of the mini tractor up and down.\n",
    "\n",
    "This Notebook acts as an **HMI** in terms of the S³I and a **client** in terms of OAuth authentication. Enter the id of your HMI with the corresponding secret as *hmi* in this script to make this notebook to your HMI. Running this notebook, you will authorize your HMI to call up the mini tractor's AcceptsShieldCommands service. \n",
    "Just go to the **Cell** drop-down menu and use the **Run All** button."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "First, all necessary modules are imported into the script, including the S³I library."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import s3i\n",
    "import json\n",
    "import uuid\n",
    "import jwt\n",
    "import time\n",
    "import os\n",
    "import base64\n",
    "import getpass\n",
    "import requests\n",
    "from tools import print_with_timestamp, check_for_quotes, check_message_encryption, yes, no, up, down"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Configure the notebook\n",
    "In order to use the S³I this notebook needs a client id and the respective secret. You can assign this notebook to your personal HMI, to make this notebook your HMI. Therefore enter the id and the secret of your HMI in the following input fields."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print_with_timestamp(\"Assign a client to this notebook. (The id of your HMI)\")\n",
    "hmiId = input('[S3I]: Please enter your HMI id:').strip(',\" ')\n",
    "hmiSecret = getpass.getpass('[S3I]: Please enter your HMI secret:').strip(',\" ')\n",
    "print_with_timestamp(\"HMI id and secret are set\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Next, you have to enter your username and password. With your access data a token is requested which authorizes this client (your HMI) to call up the mini tractor's AcceptsShieldCommands service on your behalf."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print_with_timestamp(\"Please log in!\")\n",
    "username = input('[S3I]: Please enter your username:').strip(',\" ')\n",
    "password = getpass.getpass('[S3I]: Please enter the password:')\n",
    "print_with_timestamp(\"Your credentials are sent to S3I IdentityProvider.\")\n",
    "s3i_identity_provider = s3i.IdentityProvider(grant_type='password', \n",
    "                                             identity_provider_url=\"https://idp.s3i.vswf.dev/\",\n",
    "                                             realm='KWH',\n",
    "                                             client_id=hmiId,\n",
    "                                             client_secret=hmiSecret,\n",
    "                                             username=username,\n",
    "                                             password=password)\n",
    "access_token = s3i_identity_provider.get_token(s3i.TokenType.ACCESS_TOKEN)\n",
    "\n",
    "''' decode the access token\n",
    "'''\n",
    "parsed_username = jwt.decode(access_token, verify=False)[\n",
    "    \"preferred_username\"]\n",
    "\n",
    "print_with_timestamp(\"Token received, \" + parsed_username + \" logged in.\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "After the token has been received, it can be used to query the endpoint of the mini tractor. To query the mini tractor in the S³I Directory, you must have the rights to view the mini tractor. With the creation of your S³I account you should have got this right. In case of problems please contact the S³I team (s3i@kwh40.de).\n",
    "\n",
    "Besides the endpoint of the mini tractor, the enpoint of this HMI is also needed to add as \"ReplyToEnpoint\" field in the request. The endpoint of this HMI is also queried from the directory, as it may has changed. By querying its own endpoint from the directory, the HMI is independent of changes made to its own endpoint. These changes then only need to be listed in the directory."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "''' authentication with JWT in S3I Directory \n",
    "'''\n",
    "\n",
    "s3i_directory = s3i.Directory(\n",
    "    s3i_dir_url=\"https://dir.s3i.vswf.dev/api/2/\", token=access_token)\n",
    "\n",
    "print_with_timestamp(\"Authentication with Token in S3I Directory successful\")\n",
    "    \n",
    "''' query the sender's endpoint\n",
    "'''\n",
    "sender_endpoint = s3i_directory.queryThingIDBased(hmiId+\"/attributes/allEndpoints\")[0]\n",
    "    \n",
    "''' query the mini tractor's Id and endpoint\n",
    "'''\n",
    "miniTractorID = s3i_directory.queryAttributeBased(\n",
    "    \"name\", \"gSFL Demo Rückeraupe\")[0][\"thingId\"]\n",
    "\n",
    "miniTractorEndpoint = s3i_directory.queryThingIDBased(miniTractorID+\"/attributes/allEndpoints\")\n",
    "\n",
    "receivers = [miniTractorID]\n",
    "receiver_endpoints = miniTractorEndpoint"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## MessageId Storage\n",
    "The messageId storage stores all message ids from the messages which are send. If a message arrives it is checked against these ids, to see if it is a response to one of these messages. If it is not a response to one a request send from this notebook, the message won't be parsed."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "messageIds = list()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Prepare the Service Request\n",
    "After querying the enpoints, the message (a service request) is prepared."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print_with_timestamp(\"Prepare the GetValueRequest.\")\n",
    "operation_input = input(\n",
    "    '[S3I]: Please enter the operation for shield (up or down)').strip(',\" ')\n",
    "if operation_input in up:\n",
    "    operation = \"shieldUp\"\n",
    "elif operation_input in down:\n",
    "    operation = \"shieldDown\"\n",
    "else:\n",
    "    print(\"Error: I am not able to interpret the entered operation. Run all below from here and and use \\\"up\\\" or \\\"down\\\" as an operation.\")\n",
    "    raise NameError\n",
    "speed = input(\n",
    "        '[S3I]: Please enter the speed level ([0,1])').strip(',\" ')\n",
    "parameters = {\"operation\": operation, \"speed_level\": speed}\n",
    "msg_uuid = \"s3i:\" + str(uuid.uuid4())\n",
    "servReq = s3i.ServiceRequest()\n",
    "servReq.fillServiceRequest(senderUUID=hmiId, receiverUUID=receivers, sender_endpoint=sender_endpoint,\n",
    "                               serviceType=\"fml40::AcceptsShieldCommands\", parameters=parameters, msgUUID=msg_uuid)\n",
    "    \n",
    "print_with_timestamp(\"ServiceRequest prepared:\")\n",
    "print(json.dumps(servReq.msg, indent=2))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# >>> *Run All below* from here to send the service request again\n",
    "## Send the request\n",
    "The HMI requests a new token to establish a connection to the broker and sends the request to the mini tractor's endpoint. It then checks incoming responses."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "print_with_timestamp(\"Sending the ServiceRequest to the mini tractor\")\n",
    "access_token = s3i_identity_provider.get_token(s3i.TokenType.ACCESS_TOKEN)\n",
    "headers = {'Content-Type': 'application/json', 'Authorization': 'Bearer ' + access_token}\n",
    "messageIds.append(servReq.msg[\"identifier\"])\n",
    "response = requests.post(url=\"https://broker.s3i.vswf.dev/\"+receiver_endpoints[0] ,\n",
    "                                data=json.dumps(servReq.msg), headers=headers)\n",
    "print_with_timestamp(response.text)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Receive the mini tractor's response"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "def receive():\n",
    "    print_with_timestamp(\"Checking the mini tractor's response\")\n",
    "    access_token = s3i_identity_provider.get_token(s3i.TokenType.ACCESS_TOKEN)\n",
    "    headers = {'Content-Type': 'application/json', 'Authorization': 'Bearer ' + access_token}\n",
    "    response = requests.get(url=\"https://broker.s3i.vswf.dev/\"+sender_endpoint , headers=headers)\n",
    "    json_acceptable_string = response.text.replace(\"'\", \"\\\"\")\n",
    "    \n",
    "    if json_acceptable_string:\n",
    "        if check_message_encryption(response.text.strip('\"')) == \"pgp\":\n",
    "            print_with_timestamp(\"You received a PGP message but this notebook can not decrypt PGP messages. Use the 03_inbox notebook to receive PGP messages.\")\n",
    "            print_with_timestamp(\"PGP Message: \" + response.text)\n",
    "            repeat()\n",
    "        else: \n",
    "            response_json = json.loads(json_acceptable_string)\n",
    "            print_with_timestamp(\"You received a message: \" + json.dumps(response_json, indent=2))\n",
    "            if response_json[\"replyingToMessage\"] in messageIds:\n",
    "                print_with_timestamp(\"It is the respose from the mini tractor concerning your service request with the id \" + response_json[\"replyingToMessage\"] + \". Your result is: \" + json.dumps(response_json[\"results\"], indent=2))\n",
    "                messageIds.remove(response_json[\"replyingToMessage\"])\n",
    "    else:\n",
    "        print_with_timestamp(\"The mini tractor did not respond yet.\")\n",
    "        repeat()\n",
    "\n",
    "def repeat():\n",
    "    decision = input(\"[S3I] Do you want to check for new messages again? [j/n]\")\n",
    "    if decision in yes:\n",
    "        receive()\n",
    "    elif decision in no:\n",
    "        print_with_timestamp(\"You do not want to check for more messages. If you want to check for new messages, just execute this cell again (Run button or SHIFT+RETURN)\")\n",
    "    else:\n",
    "        print_with_timestamp(\"I could not understand your response. If you want to check for new messages, just execute this cell again (Run button or SHIFT+RETURN)\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "receive()"
   ]
  }
 ],
 "metadata": {
  "file_extension": ".py",
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.0"
  },
  "mimetype": "text/x-python",
  "name": "python",
  "npconvert_exporter": "python",
  "pygments_lexer": "ipython3",
  "version": 3
 },
 "nbformat": 4,
 "nbformat_minor": 2
}