=========
IoT Input
=========
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:966150f524b6593273b979893d6dbd787489574e12986c6c754661081b8351e9
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fiot-lightgray.png?logo=github
:target: https://github.com/OCA/iot/tree/17.0/iot_input_oca
:alt: OCA/iot
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/iot-17-0/iot-17-0-iot_input_oca
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/iot&target_branch=17.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This addon allows to use a device in order to input data to odoo
automatically.
It opens a URL that a device can use to connect (with a password) that
can only execute an specific action.
Inputs are useful when a device wants to communicate to odoo for a
single and simple action. This way, the device does not need to be
configured with a odoo user and password, it is handled by odoo devices.
Examples:
- Sending the temperature every three minutes.
- Sending the RFID that the device has received in order to perform
some action
**Table of contents**
.. contents::
:local:
Usage
=====
There are two endpoints you can use: Endpoint 1: /iot/<serial>/action
Takes application/x-www-form-urlencoded parameters: passphase, value
(where value is a JSON object)
1. Create a Device on IoT > Config Devices
2. Access the Inputs section of the device
3. Create an input. You must define a serial, passphrase, function and
model
The function that the system will call must be of the following kind:
::
@api.model
def call_function(self, key):
return {}
Where key is the input string send by the device and the result must be
a dictionary that will be responded to the device as a JSON.
Endpoint 2: /iot/<device_identification>/multi_input It can be used to
send values with multiple data in one POST request such as: - Values for
inputs of the same device with different address (multi input) - Values
for inputs of the same device with same address, different values (multi
event) - Mix of the above (multi input, multi event)
Takes application/x-www-form-urlencoded parameters: passphase, values (a
JSON array of JSON objects)
It is called using device_identification and passing two POST
parameters: device passphrase and a JSON string containing an array of
values for input - The value for the address key can be a string or a
numeric (to conserve bytes in memory restricted devices when creating
the JSON object) and is converted to string when parsing. - The value
for the value key can either be string, number or boolean according to
JSON specs. You can see an example of a valid JSON input object in the
examples folder, using a few combinations.
It requires the function that the system will call must be of the
following kind:
::
@api.model
def call_function(self, key):
'do something
if err:
return {'status': 'error', 'message': 'The error message you want to send to the device'}
return {'status': 'ok', 'message': 'Optional success message'}
Where key is a dict send by the device having at least value for keys:
'address', 'value'
The function must always return a JSON with status and message. If value
contains a value with 'uuid' as key, it is returned along with the
object for the IoT device to identify success/failure per record.
It has full error reporting and the return value is a JSON array of
dicts containing at least status and message. Error message respose is
at some points generic, though extended logging is done in Odoo server
logs.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/iot/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/iot/issues/new?body=module:%20iot_input_oca%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
-------
* Creu Blanca
Contributors
------------
- Enric Tobella <etobella@creublanca.es>
- Dimitrios Tanis <dtanis@tanisfood.gr>
Maintainers
-----------
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.
.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
:target: https://github.com/etobella
:alt: etobella
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-etobella|
This module is part of the `OCA/iot <https://github.com/OCA/iot/tree/17.0/iot_input_oca>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/iot",
"name": "odoo-addon-iot-input-oca",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Creu Blanca, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "=========\nIoT Input\n=========\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:966150f524b6593273b979893d6dbd787489574e12986c6c754661081b8351e9\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fiot-lightgray.png?logo=github\n :target: https://github.com/OCA/iot/tree/17.0/iot_input_oca\n :alt: OCA/iot\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/iot-17-0/iot-17-0-iot_input_oca\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/iot&target_branch=17.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis addon allows to use a device in order to input data to odoo\nautomatically.\n\nIt opens a URL that a device can use to connect (with a password) that\ncan only execute an specific action.\n\nInputs are useful when a device wants to communicate to odoo for a\nsingle and simple action. This way, the device does not need to be\nconfigured with a odoo user and password, it is handled by odoo devices.\n\nExamples:\n\n- Sending the temperature every three minutes.\n- Sending the RFID that the device has received in order to perform\n some action\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUsage\n=====\n\nThere are two endpoints you can use: Endpoint 1: /iot/<serial>/action\n\nTakes application/x-www-form-urlencoded parameters: passphase, value\n(where value is a JSON object)\n\n1. Create a Device on IoT > Config Devices\n2. Access the Inputs section of the device\n3. Create an input. You must define a serial, passphrase, function and\n model\n\nThe function that the system will call must be of the following kind:\n\n::\n\n @api.model\n def call_function(self, key):\n return {}\n\nWhere key is the input string send by the device and the result must be\na dictionary that will be responded to the device as a JSON.\n\nEndpoint 2: /iot/<device_identification>/multi_input It can be used to\nsend values with multiple data in one POST request such as: - Values for\ninputs of the same device with different address (multi input) - Values\nfor inputs of the same device with same address, different values (multi\nevent) - Mix of the above (multi input, multi event)\n\nTakes application/x-www-form-urlencoded parameters: passphase, values (a\nJSON array of JSON objects)\n\nIt is called using device_identification and passing two POST\nparameters: device passphrase and a JSON string containing an array of\nvalues for input - The value for the address key can be a string or a\nnumeric (to conserve bytes in memory restricted devices when creating\nthe JSON object) and is converted to string when parsing. - The value\nfor the value key can either be string, number or boolean according to\nJSON specs. You can see an example of a valid JSON input object in the\nexamples folder, using a few combinations.\n\nIt requires the function that the system will call must be of the\nfollowing kind:\n\n::\n\n @api.model\n def call_function(self, key):\n 'do something\n if err:\n return {'status': 'error', 'message': 'The error message you want to send to the device'}\n return {'status': 'ok', 'message': 'Optional success message'}\n\nWhere key is a dict send by the device having at least value for keys:\n'address', 'value'\n\nThe function must always return a JSON with status and message. If value\ncontains a value with 'uuid' as key, it is returned along with the\nobject for the IoT device to identify success/failure per record.\n\nIt has full error reporting and the return value is a JSON array of\ndicts containing at least status and message. Error message respose is\nat some points generic, though extended logging is done in Odoo server\nlogs.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/iot/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/iot/issues/new?body=module:%20iot_input_oca%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Creu Blanca\n\nContributors\n------------\n\n- Enric Tobella <etobella@creublanca.es>\n- Dimitrios Tanis <dtanis@tanisfood.gr>\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\n.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px\n :target: https://github.com/etobella\n :alt: etobella\n\nCurrent `maintainer <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-etobella| \n\nThis module is part of the `OCA/iot <https://github.com/OCA/iot/tree/17.0/iot_input_oca>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "IoT Input module",
"version": "17.0.1.0.0.4",
"project_urls": {
"Homepage": "https://github.com/OCA/iot"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b09fb96149d0b03dc631efb547b96c3936b63d05bbb6d9b314e2d5fe420565a",
"md5": "bdfe37e1ee8c8e354582150454c42d1b",
"sha256": "e969f6b951566cfa81a49161e88cce284169b189c5d3db0cb61828d6df20aed8"
},
"downloads": -1,
"filename": "odoo_addon_iot_input_oca-17.0.1.0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdfe37e1ee8c8e354582150454c42d1b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 39111,
"upload_time": "2024-08-31T03:14:19",
"upload_time_iso_8601": "2024-08-31T03:14:19.254071Z",
"url": "https://files.pythonhosted.org/packages/7b/09/fb96149d0b03dc631efb547b96c3936b63d05bbb6d9b314e2d5fe420565a/odoo_addon_iot_input_oca-17.0.1.0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 03:14:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "iot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pika",
"specs": []
}
],
"lcname": "odoo-addon-iot-input-oca"
}
JSON
