flask-web-api.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# byte handling examples\n",
    "\n",
    "* bytes()\n",
    "* bytearray()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "'''\n",
    "empty_bytes =bytes(4)\n",
    "#print(type(empty_bytes))\n",
    "#print(empty_bytes)\n",
    "\n",
    "mutable_bytes = bytearray(empty_bytes)\n",
    "#print(mutable_bytes)\n",
    "\n",
    "mutable_bytes[0] = 255\n",
    "mutable_bytes.append(255)\n",
    "print(mutable_bytes)\n",
    "\n",
    "immutable_bytes = bytes(mutable_bytes)\n",
    "print(immutable_bytes)\n",
    "'''\n",
    "empty_bytes = bytes(4)\n",
    "mutable_bytes = bytearray(empty_bytes)\n",
    "mutable_bytes[0] = 1\n",
    "mutable_bytes[1] = 2\n",
    "mutable_bytes[2] = 3\n",
    "mutable_bytes[3] = 4\n",
    "pad_bytes = bytes(mutable_bytes)\n",
    "bins = bytes(0)\n",
    "print(bins)\n",
    "print(empty_bytes + pad_bytes)\n",
    "'''\n",
    "print(type(empty_bytes))\n",
    "print(empty_bytes[0:2])\n",
    "print(empty_bytes[:2])\n",
    "print(empty_bytes[2:])\n",
    "print(empty_bytes + pad_bytes)\n",
    "'''"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Simple web api - I"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from flask import Flask, url_for\n",
    "app = Flask(__name__)\n",
    "\n",
    "@app.route('/')\n",
    "def api_root():\n",
    "    return 'Welcome'\n",
    "\n",
    "@app.route('/articles')\n",
    "def api_articles():\n",
    "    return 'List of ' + url_for('api_articles')\n",
    "\n",
    "@app.route('/articles/<articleid>')\n",
    "def api_article(articleid):\n",
    "    return 'you are reading ' + articleid\n",
    "\n",
    "if __name__ == '__main__':\n",
    "    app.run()\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Simple Web Api II"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from flask import json, Flask, request\n",
    "app = Flask(__name__)\n",
    "@app.route('/messages', methods = ['POST'])\n",
    "def api_message():\n",
    "\n",
    "    if request.headers['Content-Type'] == 'text/plain':\n",
    "        return \"Text Message: \" + request.data\n",
    "\n",
    "    elif request.headers['Content-Type'] == 'application/json':\n",
    "        return \"JSON Message: \" + json.dumps(request.json)\n",
    "\n",
    "    elif request.headers['Content-Type'] == 'application/octet-stream':\n",
    "        f = open('./binary', 'wb')\n",
    "        f.write(request.data)\n",
    "        f.close()\n",
    "        return \"Binary message written!\"\n",
    "    else:\n",
    "        return \"JSON Message: \" + json.dumps(request.json)\n",
    "\n",
    "if __name__ == '__main__':\n",
    "    app.run()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# More detailed Web Api"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from flask import Flask, jsonify, abort, make_response\n",
    "from flask_restful import Resource, Api\n",
    "from flask_restful import reqparse\n",
    "\n",
    "app = Flask(__name__)\n",
    "\n",
    "tasks = [\n",
    "    {\n",
    "        'id': 1,\n",
    "        'title': u'Buy groceries',\n",
    "        'description': u'Milk, Cheese, Pizza, Fruit, Tylenol',\n",
    "        'done': False\n",
    "    },\n",
    "    {\n",
    "        'id': 2,\n",
    "        'title': u'Learn Python',\n",
    "        'description': u'Need to find a good Python tutorial on the web',\n",
    "        'done': False\n",
    "    }\n",
    "]\n",
    "\n",
    "@app.route('/todo/api/v1.0/tasks', methods=['GET'])\n",
    "def get_tasks():\n",
    "    return jsonify({'tasks': tasks})\n",
    "\n",
    "@app.route('/todo/api/v1.0/tasks/<int:task_id>', methods=['GET'])\n",
    "def get_task(task_id):\n",
    "    task = [task for task in tasks if task['id'] == task_id]\n",
    "    if len(task) == 0:\n",
    "        abort(404)\n",
    "    return jsonify({'task': task[0]})\n",
    "\n",
    "@app.errorhandler(404)\n",
    "def not_found(error):\n",
    "    return make_response(jsonify({'error': 'Not found'}), 404)\n",
    "\n",
    "if __name__ == '__main__':\n",
    "    app.run(host='0.0.0.0', port=80, debug=True)\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# TCP Server Example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# TCP server example\n",
    "import socket\n",
    "server_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)\n",
    "server_socket.bind((\"\", 5000))\n",
    "server_socket.listen(5)\n",
    "\n",
    "print (\"TCPServer Waiting for client on port 5000\")\n",
    "\n",
    "while 1:\n",
    "\tclient_socket, address = server_socket.accept()\n",
    "\tprint (\"I got a connection from \", address)\n",
    "\twhile 1:\n",
    "\t\tdata = input('SEND( TYPE q or Q to Quit):')\n",
    "\t\tif(data == 'Q' or data == 'q'):\n",
    "\t\t\tclient_socket.send (data.encode())\n",
    "\t\t\tclient_socket.close()\n",
    "\t\t\tbreak\n",
    "\t\telse:\n",
    "\t\t\tclient_socket.send(data.encode())\n",
    "\t\t\n",
    "\t\tdata = client_socket.recv(512).decode()\n",
    "\t\tif(data == 'q' or data == 'Q'):\n",
    "\t\t\tclient_socket.close()\n",
    "\t\t\tbreak;\n",
    "\t\telse:\n",
    "\t\t\tprint (\"RECEIVED:\" , data)\n",
    "\tbreak;\n",
    "server_socket.close()\n",
    "print(\"SOCKET closed... END\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Message Class"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "class message():\n",
    "\n",
    "    def parse(self, bins):\n",
    "        json = {}\n",
    "        _bytes = bytearray(bins)\n",
    "\n",
    "        '''\n",
    "        message_type :        \n",
    "            1. W : PC 에서 ETN DEVICE로 Data를 보내는 의미로 'W'=0x57을 보낸다.\n",
    "            2. R : PC 에서 ETN DEVICE로 STATUS 정보를 보내라는 의미로 'R'=0x52을 보낸다.\n",
    "            3. A : ETN DEVICE에서 PC로 REQ에 대한 ACK를 보낸다는 의미로 'A'=0x41을 보낸다.\n",
    "        '''        \n",
    "        if _bytes[0] == 0x57:\n",
    "            json[\"message_type\"] = \"W\"        \n",
    "        elif _bytes[0] == 0x52:\n",
    "            json[\"message_type\"] = \"R\"\n",
    "        elif _bytes[0] == 0x41:\n",
    "            json[\"message_type\"] = \"A\"\n",
    "        else:\n",
    "            json[\"message_type\"] = \"Unknown\"\n",
    "\n",
    "        '''\n",
    "        sound_group : \n",
    "            1. 현재 설정된 Group 정보가 들어 있다\n",
    "                1) 0x00 : WS(5 Warning Sounds) *ETNB Product (built-in buzzer)\n",
    "                2) 0x01 : WP(Special 5 Warning Sounds)\n",
    "                3) 0x02 : WM(5 sounds of melody)\n",
    "                4) 0x03 : WA(5 sounds of alarm)\n",
    "                5) 0x04 : WB(Play buzzer sound)\n",
    "        '''\n",
    "        if _bytes[1] == 0x00:\n",
    "            json['sound_group'] = 'WS'\n",
    "        elif _bytes[1] == 0x01:\n",
    "            json['sound_group'] = 'WP'\n",
    "        elif _bytes[1] == 0x02:\n",
    "            json['sound_group'] = 'WM'\n",
    "        elif _bytes[1] == 0x03:\n",
    "            json['sound_group'] = 'WA'\n",
    "        elif _bytes[1] == 0x04:\n",
    "            json['sound_group'] = 'WB'\n",
    "        else:\n",
    "            json['sound_group'] = 'Unknown'\n",
    "\n",
    "        '''\n",
    "        [lamp common setting]\n",
    "            1) 0x00: LAMP OFF\n",
    "            2) 0x01: LAMP BLINK(ON / OFF)\n",
    "            3) 0x02: LAMP ON\n",
    "            4) Else: N / A\n",
    "        '''\n",
    "\n",
    "        '''\n",
    "        red_lamp\n",
    "        '''           \n",
    "        if _bytes[2] == 0x00:\n",
    "            json[\"red_lamp\"] = \"blink\"\n",
    "        elif _bytes[2] == 0x01:\n",
    "            json[\"red_lamp\"] = \"on\"\n",
    "        elif _bytes[2] == 0x02:\n",
    "            json[\"red_lamp\"] = \"blink\"\n",
    "        else:\n",
    "            json[\"red_lamp\"] = \"Unknown\"\n",
    "\n",
    "        '''\n",
    "        yellow_lamp\n",
    "        '''\n",
    "        if _bytes[3] == 0x00:\n",
    "            json[\"yellow_lamp\"] = \"blink\"\n",
    "        elif _bytes[3] == 0x01:\n",
    "            json[\"yellow_lamp\"] = \"on\"\n",
    "        elif _bytes[3] == 0x02:\n",
    "            json[\"yellow_lamp\"] = \"blink\"\n",
    "        else:\n",
    "            json[\"yellow_lamp\"] = \"Unknown\"\n",
    "\n",
    "        '''\n",
    "        green_lamp\n",
    "        '''\n",
    "        if _bytes[4] == 0x00:\n",
    "            json[\"green_lamp\"] = \"blink\"\n",
    "        elif _bytes[4] == 0x01:\n",
    "            json[\"green_lamp\"] = \"on\"\n",
    "        elif _bytes[4] == 0x02:\n",
    "            json[\"green_lamp\"] = \"blink\"\n",
    "        else:\n",
    "            json[\"green_lamp\"] = \"Unknown\"\n",
    "        \n",
    "        '''\n",
    "        blue_lamp\n",
    "        '''\n",
    "        if _bytes[5] == 0x00:\n",
    "            json[\"blue_lamp\"] = \"blink\"\n",
    "        elif _bytes[5] == 0x01:\n",
    "            json[\"blue_lamp\"] = \"on\"\n",
    "        elif _bytes[5] == 0x02:\n",
    "            json[\"blue_lamp\"] = \"blink\"\n",
    "        else:\n",
    "            json[\"blue_lamp\"] = \"Unknown\"\n",
    "\n",
    "        '''\n",
    "        white_lamp\n",
    "        '''\n",
    "        if _bytes[6] == 0x00:\n",
    "            json[\"white_lamp\"] = \"blink\"\n",
    "        elif _bytes[6] == 0x01:\n",
    "            json[\"white_lamp\"] = \"on\"\n",
    "        elif _bytes[6] == 0x02:\n",
    "            json[\"white_lamp\"] = \"blink\"\n",
    "        else:\n",
    "            json[\"white_lamp\"] = \"Unknown\"\n",
    "\n",
    "        json[\"sound_channel\"] = int(_bytes[7])\n",
    "\n",
    "        return json\n",
    "\n",
    "    def generate(self, json):\n",
    "        _bytes = bytearray(bytes(10))\n",
    "\n",
    "        '''\n",
    "        message_type :        \n",
    "            1. W : PC 에서 ETN DEVICE로 Data를 보내는 의미로 'W'=0x57을 보낸다.\n",
    "            2. R : PC 에서 ETN DEVICE로 STATUS 정보를 보내라는 의미로 'R'=0x52을 보낸다.\n",
    "            3. A : ETN DEVICE에서 PC로 REQ에 대한 ACK를 보낸다는 의미로 'A'=0x41을 보낸다.\n",
    "        '''\n",
    "        if json['message_type'] == 'W':\n",
    "            _bytes[0] = 0x57\n",
    "        elif json['message_type'] == 'R':\n",
    "            _bytes[0] = 0x52\n",
    "        elif json['message_type'] == 'A':\n",
    "            _bytes[0] = 0x41\n",
    "        else:\n",
    "            print('error')\n",
    "\n",
    "        '''\n",
    "        sound_group : \n",
    "            1. 현재 설정된 Group 정보가 들어 있다\n",
    "                1) 0x00 : WS(5 Warning Sounds) *ETNB Product (built-in buzzer)\n",
    "                2) 0x01 : WP(Special 5 Warning Sounds)\n",
    "                3) 0x02 : WM(5 sounds of melody)\n",
    "                4) 0x03 : WA(5 sounds of alarm)\n",
    "                5) 0x04 : WB(Play buzzer sound)\n",
    "        '''\n",
    "        if json['sound_group'] == 'WS':\n",
    "            _bytes[1] = 0x00\n",
    "        elif json['sound_group'] == 'WP':    \n",
    "            _bytes[1] = 0x01\n",
    "        elif json['sound_group'] == 'WM':    \n",
    "            _bytes[1] = 0x02\n",
    "        elif json['sound_group'] == 'WA':    \n",
    "            _bytes[1] = 0x03\n",
    "        elif json['sound_group'] == 'WB':    \n",
    "            _bytes[1] = 0x04\n",
    "\n",
    "        '''\n",
    "        [lamp common setting]\n",
    "            1) 0x00: LAMP OFF\n",
    "            2) 0x01: LAMP BLINK(ON / OFF)\n",
    "            3) 0x02: LAMP ON\n",
    "            4) Else: N / A\n",
    "        '''\n",
    "\n",
    "        '''\n",
    "        red_lamp\n",
    "        '''           \n",
    "        if json[\"red_lamp\"] == \"on\":\n",
    "            _bytes[2] = 0x01\n",
    "        elif json[\"red_lamp\"] == \"blink\":\n",
    "            _bytes[2] = 0x02\n",
    "        else :\n",
    "            _bytes[2] = 0x00\n",
    "\n",
    "        '''\n",
    "        yellow_lamp\n",
    "        '''\n",
    "        if json[\"yellow_lamp\"] == \"on\":\n",
    "            _bytes[3] = 0x01\n",
    "        elif json[\"yellow_lamp\"] == \"blink\":\n",
    "            _bytes[3] = 0x02\n",
    "        else :\n",
    "            _bytes[3] = 0x00\n",
    "\n",
    "        '''\n",
    "        green_lamp\n",
    "        '''\n",
    "        if json[\"green_lamp\"] == \"on\":\n",
    "            _bytes[4] = 0x01\n",
    "        elif json[\"green_lamp\"] == \"blink\":\n",
    "            _bytes[4] = 0x02\n",
    "        else:\n",
    "            _bytes[4] = 0x00\n",
    "\n",
    "        '''\n",
    "        blue_lamp\n",
    "        '''\n",
    "        if json[\"blue_lamp\"] == \"on\":\n",
    "            _bytes[5] = 0x01\n",
    "        elif json[\"blue_lamp\"] == \"blink\":\n",
    "            _bytes[5] = 0x02\n",
    "        else:\n",
    "            _bytes[5] = 0x00\n",
    "\n",
    "        '''\n",
    "        white_lamp\n",
    "        '''\n",
    "        if json[\"white_lamp\"] == 'on':\n",
    "            _bytes[6] = 0x01\n",
    "        elif json[\"white_lamp\"] == \"blink\":\n",
    "            _bytes[6] = 0x02\n",
    "        else:\n",
    "            _bytes[6] = 0x00\n",
    "\n",
    "        _bytes[7] = json[\"sound_channel\"]\n",
    "\n",
    "        return bytes(_bytes)\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Socket Client Example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import socket\n",
    "import message\n",
    "\n",
    "json_list = []\n",
    "\n",
    "json = {\n",
    "    \"message_type\": \"W\",\n",
    "    \"sound_group\": \"WP\",\n",
    "    \"red_lamp\": 'blink',\n",
    "    \"yellow_lamp\": 'blink',\n",
    "    \"green_lamp\": 'on',\n",
    "    \"blue_lamp\": 'blink',\n",
    "    \"white_lamp\": 'on',\n",
    "    \"sound_channel\": 1\n",
    "}\n",
    "\n",
    "json_list.append(json)\n",
    "\n",
    "\n",
    "json = { \n",
    "    'message_type': 'W',\n",
    "    'sound_group': 'WA',\n",
    "    'red_lamp': 'blink',\n",
    "    'yellow_lamp': 'blink',\n",
    "    'green_lamp': 'on', \n",
    "    'blue_lamp': 'blink', \n",
    "    'white_lamp': 'on', \n",
    "    'sound_channel': 1\n",
    "}\n",
    "\n",
    "json_list.append(json)\n",
    "\n",
    "#message.generate(json)\n",
    "msg = message.message()\n",
    "bin_msg = msg.generate(json)\n",
    "ip = \"127.0.0.1\"\n",
    "port = 20000\n",
    "with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:\n",
    "    s.connect((ip, port))   \n",
    "    s.send(bin_msg)\n",
    "    if json[\"message_type\"] == \"R\" :\n",
    "        bins = bytes(0)\n",
    "        while 1:\n",
    "            bins += s.recv(512)\n",
    "            if len(bins) > 9:\n",
    "                json = msg.parse(bins[:10])  \n",
    "                print(json)              \n",
    "                break\n",
    "    s.close()\n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Socker Server Example"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import socket\n",
    "import message\n",
    "\n",
    "msg = message.message()\n",
    "host = '127.0.0.1'\n",
    "port = 20000\n",
    "\n",
    "with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:\n",
    "    s.bind((host, port))\n",
    "    s.listen(5)\n",
    "    while 1:\n",
    "        client, address = s.accept()\n",
    "        bins = bytes(0)\n",
    "        while 1:        \n",
    "            bins += client.recv(512)            \n",
    "            if len(bins) > 9:\n",
    "                json = msg.parse(bins[:10])\n",
    "                print(json)\n",
    "                if json[\"message_type\"] == \"R\":\n",
    "                    json[\"message_type\"] = \"A\"\n",
    "                    \n",
    "                    client.send(msg.generate(json))                \n",
    "                break"
   ]
  }
 ],
 "metadata": {
  "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.5.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}