__START__.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<img style=\"float: right;padding: 10px;margin-left:20px;\" width=\"200\" src=\"images/logo-onem2m-the-iot-standard.jpg\">\n",
    "\n",
    "# oneM2M Jupyter Notebooks\n",
    "\n",
    "These notebooks provide an introduction the RESTful IoT API of a oneM2M Common Services Entity (CSE).  \n",
    "The CSE uses the [oneM2M standard](https://onem2m.org) and its technologies as the base for defining IoT resources, their behaviour, and how to work with them in a RESTful way.\n",
    "\n",
    "In these notebooks we will show how to work with the resources, store and retrieve data, and more.\n",
    "\n",
    "### Working with Jupyter Notebooks\n",
    "\n",
    "To quote [Jupyter Notebook Introduction for Beginners](https://geekflare.com/jupyter-notebook-basics/):\n",
    "\n",
    "\n",
    ">The Jupyter Notebook is an open-source web application that allows you to create and share documents that contain live code, equations, visualizations, and narrative text. It uses include data cleaning and transformation, numerical simulation, statistical modeling, data visualization, machine learning, and much more.  \n",
    "Most often, the Jupyter Notebook is used in a Python environment. They have very interactive outputs and can be easily shareable, just like a regular notebook.\n",
    "\n",
    "Each notebook consists of text and executable cells, like the following one. Just select this cell and execute it by clicking the ```Run``` button at the top of the page. \n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "for i in range(4):\n",
    "    print('Hello, oneM2M')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The Python code in this cell is executed and the output put after it.\n",
    "\n",
    "For the exercises in the notebooks most of the time all you have to do is to execute all the executable cells and observe the output.  \n",
    "However, you are free to experiment as much as you like.\n",
    "\n",
    "## CSE Runtime & Notification Server Notebooks\n",
    "\n",
    "<img style=\"float: right;\" width=\"80\" src=\"images/setup.png\">\n",
    "\n",
    "\n",
    "### Running the CSE\n",
    "\n",
    "\n",
    "- [start-cse.ipynb](start-cse.ipynb)  \n",
    "This notebook runs a local CSE instance inside the Jupyter notebooks. It is required for all the examples in the notebooks.\n",
    "\n",
    "<p>\n",
    "<div  style=\"background-color:transparent;border:2px #005480 solid;padding: 10px;width: calc(100% - 350px);border-radius:10px;\">\n",
    "    <div style=\"color:#005480;\"><b><i class=\"fa fa-info-circle\" aria-hidden=\"true\"></i>&nbsp; Note</b></div>\n",
    "    <div style=\"color:#545054;\">\n",
    "        You need to run this notebook first before starting any of the exercises below.\n",
    "    </div>\n",
    "</div>\n",
    "</p>\n",
    "\n",
    "- [http://localhost:8080/webui](http://localhost:8080/webui/index.html?open&ri=id-in&or=CAdmin)  \n",
    "The interactive web UI of the CSE.\n",
    "\n",
    "<p>\n",
    "<div  style=\"background-color:transparent;border:2px #005480 solid;padding: 10px;width: calc(100% - 350px);border-radius:10px;\">\n",
    "    <div style=\"color:#005480;\"><b><i class=\"fa fa-info-circle\" aria-hidden=\"true\"></i>&nbsp; Note</b></div>\n",
    "    <div style=\"color:#545054;\">\n",
    "        Please note, that the web UI doesn't work when running on MyBinder.\n",
    "    </div>\n",
    "</div>\n",
    "</p>\n",
    "\n",
    "### Running the Notification Server\n",
    "\n",
    "\n",
    "- [start-notificationServer.ipynb](start-notificationServer.ipynb)  \n",
    "This notebook runs a local server for receiving notifications.\n",
    "\n",
    "<p>\n",
    "<div  style=\"background-color:transparent;border:2px #005480 solid;padding: 10px;width: calc(100% - 350px);border-radius:10px;\">\n",
    "    <div style=\"color:#005480;\"><b><i class=\"fa fa-info-circle\" aria-hidden=\"true\"></i>&nbsp; Note</b></div>\n",
    "    <div style=\"color:#545054;\">\n",
    "        The notification server is used in the notebook <a href=\"06-notifications.ipynb\" target=\"_new\">06-notifications.ipynb</a> and must be started before running the exercises in that notebook.\n",
    "    </div>\n",
    "</div>\n",
    "</p>\n",
    "\n",
    "\n",
    "## oneM2M Notebooks & Exercises\n",
    "<img style=\"float: right;\" width=\"80\" src=\"images/exercise-nb.png\">\n",
    "\n",
    "- [01-introduction.ipynb](01-introduction.ipynb)  \n",
    "An introduction that demonstrates how to retrieve the root &lt;CSEBase> resource.\n",
    "- [02-basic-resources.ipynb](02-basic-resources.ipynb)  \n",
    "This notebook shows your how to create and work with the basic oneM2M resources: &lt;AE>, &lt;container> and &lt;contentInstance>.  \n",
    "- [03-discovery.ipynb](03-discovery.ipynb)  \n",
    "How do you search for resources in a CSE?\n",
    "- [04-groups.ipynb](04-groups.ipynb)  \n",
    "Group resources together and send requests to a group instead of each single resource.\n",
    "- [05-accesscontrol.ipynb](05-accesscontrol.ipynb)  \n",
    "Control access to resources with Access Control Policies.\n",
    "- [06-notifications.ipynb](06-notifications.ipynb)  \n",
    "Subscribe to changes of resources and receive notifications.\n",
    "- [07-flexcontainer.ipynb](07-flexcontainer.ipynb)  \n",
    "What are &lt;flexContainer> resources and specializations, and how to use them?\n",
    "\n",
    "<p>\n",
    "<div style=\"background-color:transparent;border:2px #b42025 solid;padding: 10px;width: calc(100% - 350px);border-radius:10px;\">\n",
    "    <div style=\"color:#b42025;\"><b><i class=\"fa fa-info-circle\" aria-hidden=\"true\"></i>&nbsp; oneM2M</b></div>\n",
    "    <div style=\"color:#545054;\">\n",
    "        You will find that in the notebooks the oneM2M attributes in the requests and responses can easily be understood because\n",
    "        we use their assigned names. We choose to do that because it help beginners to easier understand their meanings.\n",
    "        However, in actual encodings for requests and responses oneM2M defines short names for all the attributes. This has been done to\n",
    "        save bandwidth in restricted environments.<br/>\n",
    "        You will find the actual encodings for each request and response together with a <a href=\"https://curl.se\">curl</a> \n",
    "        request and the human-readable versions in the notebooks.\n",
    "    </div>\n",
    "</div>\n",
    "</p>\n",
    "\n",
    "\n",
    "## Links\n",
    "<img style=\"float: right;\" width=\"80\" src=\"images/notebook.png\">\n",
    "\n",
    "\n",
    "\n",
    "- oneM2M home Page  \n",
    "[https://onem2m.org](https://onem2m.org)\n",
    "\n",
    "- oneM2M notebooks on GitHub  \n",
    "[https://github.com/ankraft/onem2m-jupyter-notebooks](https://github.com/ankraft/onem2m-jupyter-notebooks)\n",
    "- ACME oneM2M CSE  \n",
    "[https://github.com/ankraft/ACME-oneM2M-CSE](https://github.com/ankraft/ACME-oneM2M-CSE)\n",
    "\n",
    "\n",
    "## License\n",
    "\n",
    "These Notebooks are available under the BSD 3-Clause License."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "&nbsp;"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.9.10"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}