Skip to content

Commit 9a5ecbb

Browse files
ajaybhargavajaybhargav
committed
Change line endings to LF
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent 4be702a commit 9a5ecbb

File tree

10 files changed

+1427
-1427
lines changed

10 files changed

+1427
-1427
lines changed

‎docs/book/COPYRIGHT.rst‎

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
1-
Copyrights and Licenses
2-
=======================
3-
4-
Software Copyrights
5-
-------------------
6-
7-
All original source code in this repository is Copyright (C) 2021-2024 Waybyte Solutions. This source code is licensed under MIT as described in the file LICENSE.
8-
9-
Additional third party copyrighted code is included under the following licenses.
10-
11-
Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here.
12-
13-
Firmware Components
14-
^^^^^^^^^^^^^^^^^^^
15-
16-
These third party libraries included into the application (firmware) produced by Logicrom OpenCPU SDK.
17-
18-
* `LittleFS <https://github.com/ARMmbed/littlefs>`_ library written by ARM Limited and released under the `BSD 3-clause license <https://github.com/ARMmbed/littlefs/blob/master/LICENSE.md>`_.
19-
20-
* `Int64String <https://github.com/djGrrr/Int64String>`_ library written by djGrrr and released under the `MIT license <https://github.com/djGrrr/Int64String/blob/master/LICENSE>`__.
21-
22-
* `PicoHTTPParser <https://github.com/h2o/picohttpparser>`_ library written by Kazuho Oku, Tokuhiro Matsuno, Daisuke Murase, Shigeo Mitsunari and released under the MIT license.
23-
24-
* `heatshrink <https://github.com/atomicobject/heatshrink>`_ library written by Scott Vokes and released under the `ISC license <https://github.com/atomicobject/heatshrink/blob/master/LICENSE>`_.
25-
26-
* `SimpleKalmanFilter <https://github.com/denyssene/SimpleKalmanFilter>`_ library written by Denys Sene and released under the `MIT license <https://github.com/denyssene/SimpleKalmanFilter/blob/master/LICENSE>`__.
27-
28-
* `OneWire <https://github.com/PaulStoffregen/OneWire>`_ library originally written by Jim Studt and later maintained by Paul Stoffregen, is released uder `custom license <https://github.com/PaulStoffregen/OneWire/blob/master/OneWire.cpp>`_.
29-
30-
* `Tiny AES <https://github.com/kokke/tiny-AES-c>`_ library, released under `Unlicense <https://github.com/kokke/tiny-AES-c/blob/master/unlicense.txt>`_.
31-
32-
* `Fusion <https://github.com/xioTechnologies/Fusion/>`_ library, Copyright 2021 x-io Technologies and released under `MIT License <https://github.com/xioTechnologies/Fusion/blob/main/LICENSE.md>`__.
33-
34-
* `MQTT Client <https://github.com/jiejieTop/mqttclient>`_ library, Copyright jiejie and released under `Apache License 2.0 <https://github.com/jiejieTop/mqttclient/blob/master/LICENSE>`_.
35-
36-
* `SPIFFS <https://github.com/pellepl/spiffs>`_ library, Copyright (c) 2013-2017 Peter Andersson, is licensed under `MIT license <https://github.com/pellepl/spiffs/blob/master/LICENSE>`__.
37-
38-
39-
Documentation
40-
^^^^^^^^^^^^^
41-
42-
* HTML version of the `Logicrom OpenCPU SDK <https://docs.logicrom.com>`_ uses the `Sphinx RTD theme <https://github.com/readthedocs/sphinx_rtd_theme>`_, which is Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors, licensed under `MIT license <https://github.com/readthedocs/sphinx_rtd_theme/blob/master/LICENSE>`__.
43-
1+
Copyrights and Licenses
2+
=======================
3+
4+
Software Copyrights
5+
-------------------
6+
7+
All original source code in this repository is Copyright (C) 2021-2024 Waybyte Solutions. This source code is licensed under MIT as described in the file LICENSE.
8+
9+
Additional third party copyrighted code is included under the following licenses.
10+
11+
Where source code headers specify Copyright & License information, this information takes precedence over the summaries made here.
12+
13+
Firmware Components
14+
^^^^^^^^^^^^^^^^^^^
15+
16+
These third party libraries included into the application (firmware) produced by Logicrom OpenCPU SDK.
17+
18+
* `LittleFS <https://github.com/ARMmbed/littlefs>`_ library written by ARM Limited and released under the `BSD 3-clause license <https://github.com/ARMmbed/littlefs/blob/master/LICENSE.md>`_.
19+
20+
* `Int64String <https://github.com/djGrrr/Int64String>`_ library written by djGrrr and released under the `MIT license <https://github.com/djGrrr/Int64String/blob/master/LICENSE>`__.
21+
22+
* `PicoHTTPParser <https://github.com/h2o/picohttpparser>`_ library written by Kazuho Oku, Tokuhiro Matsuno, Daisuke Murase, Shigeo Mitsunari and released under the MIT license.
23+
24+
* `heatshrink <https://github.com/atomicobject/heatshrink>`_ library written by Scott Vokes and released under the `ISC license <https://github.com/atomicobject/heatshrink/blob/master/LICENSE>`_.
25+
26+
* `SimpleKalmanFilter <https://github.com/denyssene/SimpleKalmanFilter>`_ library written by Denys Sene and released under the `MIT license <https://github.com/denyssene/SimpleKalmanFilter/blob/master/LICENSE>`__.
27+
28+
* `OneWire <https://github.com/PaulStoffregen/OneWire>`_ library originally written by Jim Studt and later maintained by Paul Stoffregen, is released uder `custom license <https://github.com/PaulStoffregen/OneWire/blob/master/OneWire.cpp>`_.
29+
30+
* `Tiny AES <https://github.com/kokke/tiny-AES-c>`_ library, released under `Unlicense <https://github.com/kokke/tiny-AES-c/blob/master/unlicense.txt>`_.
31+
32+
* `Fusion <https://github.com/xioTechnologies/Fusion/>`_ library, Copyright 2021 x-io Technologies and released under `MIT License <https://github.com/xioTechnologies/Fusion/blob/main/LICENSE.md>`__.
33+
34+
* `MQTT Client <https://github.com/jiejieTop/mqttclient>`_ library, Copyright jiejie and released under `Apache License 2.0 <https://github.com/jiejieTop/mqttclient/blob/master/LICENSE>`_.
35+
36+
* `SPIFFS <https://github.com/pellepl/spiffs>`_ library, Copyright (c) 2013-2017 Peter Andersson, is licensed under `MIT license <https://github.com/pellepl/spiffs/blob/master/LICENSE>`__.
37+
38+
39+
Documentation
40+
^^^^^^^^^^^^^
41+
42+
* HTML version of the `Logicrom OpenCPU SDK <https://docs.logicrom.com>`_ uses the `Sphinx RTD theme <https://github.com/readthedocs/sphinx_rtd_theme>`_, which is Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors, licensed under `MIT license <https://github.com/readthedocs/sphinx_rtd_theme/blob/master/LICENSE>`__.
43+

‎docs/book/api/peri/audio.rst‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
Audio APIs
2-
==========
3-
4-
.. note:: Audio interface is currently only supported on RDA8910 chipset.
5-
6-
Example Usage
7-
-------------
8-
9-
.. code-block:: c
10-
11-
#include <audio.h>
12-
13-
/* Play an MP3 file from sdcard */
14-
audio_file_play("/sd/file.mp3", AUDIO_PLAY_LOCAL, NULL);
15-
16-
/* Play an MP3 file from sdcard during call */
17-
audio_file_play("/sd/file.mp3", AUDIO_PLAY_VOICE, NULL);
18-
19-
/* set volume */
20-
audio_set_volume(100);
21-
22-
/* play DTMF tone */
23-
audio_play_dtmf("1234", 500, false, NULL);
24-
25-
/* Record from MIC */
26-
audio_record_start("/fs/record.amr", AUDIO_REC_TYPE_MIC, AUDIO_QUALITY_MEDIUM, 5000, NULL);
27-
28-
/* Record voice call */
29-
audio_record_start("/fs/call_record.amr", AUDIO_REC_TYPE_VOICE, AUDIO_QUALITY_MEDIUM, 0, NULL);
30-
31-
32-
.. Application Example
33-
.. -------------------
34-
.. TODO
35-
36-
API Reference
37-
-------------
38-
39-
.. include:: /inc/audio.inc
1+
Audio APIs
2+
==========
3+
4+
.. note:: Audio interface is currently only supported on RDA8910 chipset.
5+
6+
Example Usage
7+
-------------
8+
9+
.. code-block:: c
10+
11+
#include <audio.h>
12+
13+
/* Play an MP3 file from sdcard */
14+
audio_file_play("/sd/file.mp3", AUDIO_PLAY_LOCAL, NULL);
15+
16+
/* Play an MP3 file from sdcard during call */
17+
audio_file_play("/sd/file.mp3", AUDIO_PLAY_VOICE, NULL);
18+
19+
/* set volume */
20+
audio_set_volume(100);
21+
22+
/* play DTMF tone */
23+
audio_play_dtmf("1234", 500, false, NULL);
24+
25+
/* Record from MIC */
26+
audio_record_start("/fs/record.amr", AUDIO_REC_TYPE_MIC, AUDIO_QUALITY_MEDIUM, 5000, NULL);
27+
28+
/* Record voice call */
29+
audio_record_start("/fs/call_record.amr", AUDIO_REC_TYPE_VOICE, AUDIO_QUALITY_MEDIUM, 0, NULL);
30+
31+
32+
.. Application Example
33+
.. -------------------
34+
.. TODO
35+
36+
API Reference
37+
-------------
38+
39+
.. include:: /inc/audio.inc

‎docs/book/api/peri/bt_classic.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Bluetooth Classic Mode API Reference
2-
====================================
3-
4-
.. include:: /inc/bluetooth.inc
5-
1+
Bluetooth Classic Mode API Reference
2+
====================================
3+
4+
.. include:: /inc/bluetooth.inc
5+

‎docs/book/api/peri/bt_le.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Bluetooth LE Mode API Reference
2-
===============================
3-
4-
.. include:: /inc/bluetooth_le.inc
5-
1+
Bluetooth LE Mode API Reference
2+
===============================
3+
4+
.. include:: /inc/bluetooth_le.inc
5+

‎docs/book/api/proto/mqtt.rst‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
1-
MQTT Client
2-
===========
3-
4-
MQTT Client library.
5-
6-
Example Usage
7-
-------------
8-
9-
.. code-block:: c
10-
11-
#include <proto/mqttclient.h>
12-
13-
mqtt_client_t *client = NULL;
14-
char client_id[32];
15-
16-
/* set a client ID */
17-
strcpy(client_id, "1234567890");
18-
/* init new mqtt client */
19-
client = mqtt_lease();
20-
/* configure host */
21-
mqtt_set_host(client, "broker.example.com");
22-
/* configure port */
23-
mqtt_set_port(client, "1883");
24-
/* set client id */
25-
mqtt_set_client_id(client, client_id);
26-
/* configure session clean */
27-
mqtt_set_clean_session(client, 1);
28-
/* connect to broker */
29-
mqtt_connect(client);
30-
/* topic subscribe */
31-
mqtt_subscribe(client, "topic1", QOS0, topic1_handler);
32-
33-
/* publish message */
34-
mqtt_message_t msg;
35-
memset(&msg, 0, sizeof(msg));
36-
/* set payload */
37-
msg.payload = "Test";
38-
/* set QOS value */
39-
msg.qos = 0;
40-
/* publish */
41-
mqtt_publish(client, "topic2", &msg);
42-
43-
44-
API Reference
45-
-------------
46-
47-
.. include:: /inc/mqttclient.inc
48-
1+
MQTT Client
2+
===========
3+
4+
MQTT Client library.
5+
6+
Example Usage
7+
-------------
8+
9+
.. code-block:: c
10+
11+
#include <proto/mqttclient.h>
12+
13+
mqtt_client_t *client = NULL;
14+
char client_id[32];
15+
16+
/* set a client ID */
17+
strcpy(client_id, "1234567890");
18+
/* init new mqtt client */
19+
client = mqtt_lease();
20+
/* configure host */
21+
mqtt_set_host(client, "broker.example.com");
22+
/* configure port */
23+
mqtt_set_port(client, "1883");
24+
/* set client id */
25+
mqtt_set_client_id(client, client_id);
26+
/* configure session clean */
27+
mqtt_set_clean_session(client, 1);
28+
/* connect to broker */
29+
mqtt_connect(client);
30+
/* topic subscribe */
31+
mqtt_subscribe(client, "topic1", QOS0, topic1_handler);
32+
33+
/* publish message */
34+
mqtt_message_t msg;
35+
memset(&msg, 0, sizeof(msg));
36+
/* set payload */
37+
msg.payload = "Test";
38+
/* set QOS value */
39+
msg.qos = 0;
40+
/* publish */
41+
mqtt_publish(client, "topic2", &msg);
42+
43+
44+
API Reference
45+
-------------
46+
47+
.. include:: /inc/mqttclient.inc
48+

‎docs/book/flash/core_reflash.rst‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
MT2503/MT6261 Core Re-Flashing
2-
==============================
3-
4-
It is possible to flash MediaTek based modules directly from IDE. Following is the procedure
5-
to flash Logicrom core via IDE.
6-
7-
Re-Flashing Core via PlatformIO
8-
-------------------------------
9-
10-
1. Open project tasks by clicking PlatformIO icon from left sidebar
11-
2. Under custom tasks, click "Reflash Core Firmware"
12-
13-
.. image:: ../../_static/platformio-ide-flash-core.png
14-
:class: auto-width
15-
:group: platformio
16-
:title: Reflash core option in PlatformIO
17-
18-
3. Reset the target board.
19-
4. Core flashing will start, check progress in terminal windows
20-
21-
.. image:: ../../_static/platformio-ide-flash-core-progress.png
22-
:class: auto-width
23-
:group: platformio
24-
:title: Flash progress in PlatformIO
25-
26-
Re-Flashing Core via Arduino
27-
----------------------------
28-
29-
1. Select Programmer from Tools -> Programmer -> Logicrom Core Flasher
30-
(MT2503/MT6261)
31-
32-
.. image:: ../../_static/arduino-ide-select-logicrom-flasher.png
33-
:class: auto-width
34-
:group: arduino
35-
:title: Configure programmer in Arduino
36-
37-
1. Select device COM port under Tools -> Port
38-
39-
.. image:: ../../_static/arduino-ide-select-logicrom-flasher-port.png
40-
:class: auto-width
41-
:group: arduino
42-
:title: Set COM port
43-
44-
3. Click Tools -> Burn Bootloader to start flashing.
45-
4. Reset the tartget board, and check flash progress in the output console.
46-
47-
.. image:: ../../_static/arduino-ide-logicrom-flasher-progress.png
48-
:class: auto-width
49-
:group: arduino
50-
:title: Flash progress in Arduino
51-
52-
53-
.. toctree::
54-
:hidden:
55-
1+
MT2503/MT6261 Core Re-Flashing
2+
==============================
3+
4+
It is possible to flash MediaTek based modules directly from IDE. Following is the procedure
5+
to flash Logicrom core via IDE.
6+
7+
Re-Flashing Core via PlatformIO
8+
-------------------------------
9+
10+
1. Open project tasks by clicking PlatformIO icon from left sidebar
11+
2. Under custom tasks, click "Reflash Core Firmware"
12+
13+
.. image:: ../../_static/platformio-ide-flash-core.png
14+
:class: auto-width
15+
:group: platformio
16+
:title: Reflash core option in PlatformIO
17+
18+
3. Reset the target board.
19+
4. Core flashing will start, check progress in terminal windows
20+
21+
.. image:: ../../_static/platformio-ide-flash-core-progress.png
22+
:class: auto-width
23+
:group: platformio
24+
:title: Flash progress in PlatformIO
25+
26+
Re-Flashing Core via Arduino
27+
----------------------------
28+
29+
1. Select Programmer from Tools -> Programmer -> Logicrom Core Flasher
30+
(MT2503/MT6261)
31+
32+
.. image:: ../../_static/arduino-ide-select-logicrom-flasher.png
33+
:class: auto-width
34+
:group: arduino
35+
:title: Configure programmer in Arduino
36+
37+
1. Select device COM port under Tools -> Port
38+
39+
.. image:: ../../_static/arduino-ide-select-logicrom-flasher-port.png
40+
:class: auto-width
41+
:group: arduino
42+
:title: Set COM port
43+
44+
3. Click Tools -> Burn Bootloader to start flashing.
45+
4. Reset the tartget board, and check flash progress in the output console.
46+
47+
.. image:: ../../_static/arduino-ide-logicrom-flasher-progress.png
48+
:class: auto-width
49+
:group: arduino
50+
:title: Flash progress in Arduino
51+
52+
53+
.. toctree::
54+
:hidden:
55+

0 commit comments

Comments
 (0)