Skip to content

Commit 134fa71

Browse files
Matteo-itMatteo-it
committed
Init storyteller
1 parent 0203a1a commit 134fa71

File tree

14 files changed

+649
-0
lines changed

14 files changed

+649
-0
lines changed

‎examples/bedtime-story-teller/README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Bedtime Story Teller Example
2+
3+
## Description
4+
This example demonstrates how to build a bedtime story teller application using Arduino UNO Q.
5+
The application shows how to use a cloud-based large language model (LLM) to generate a bedtime story based on user input.
6+
7+
## Bricks Used
8+
9+
The code detector example uses the following bricks:
10+
11+
- `cloud_llm`: brick to interact with a cloud-based large language model (LLM) for generating story content.
12+
- `web_ui`: brick to create a web interface to get user input and display the generated story.
13+
14+
## Hardware and Software Requirements
15+
16+
### Hardware
17+
18+
- Arduino UNO Q (x1)
19+
- USB camera (x1)
20+
- USB-C® to USB-A Cable (x1)
21+
- Personal computer with internet access
22+
23+
### Software
24+
25+
- Apps Lab IDE
26+
27+
Note: You can run this example using your Arduino UNO Q as a Single Board Computer (SBC) using a [USB-C hub](https://store.arduino.cc/products/usb-c-to-hdmi-multiport-adapter-with-ethernet-and-usb-hub) with a mouse, keyboard and display attached.
28+
29+
## How to Use the Example
30+
31+
1. Run the app
32+
2. Open the App on your browser
33+
34+
## How it Works
35+
36+
Here is a brief explanation of the full-stack application:
37+
38+
### 🔧 Backend (main.py)
39+
40+
### 💻 Frontend (index.html + app.js)
41+
42+
## Understanding the Code

‎examples/bedtime-story-teller/app.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: Bedtime story teller
2+
icon: 🏰
3+
description:
4+
This example shows how to create a bedtime story teller using Arduino.
5+
It uses a cloud-based language model to generate a story based on user input and shows the story on a web interface.
6+
7+
bricks:
8+
- arduino:cloud_llm
9+
variables:
10+
API_KEY: <API_KEY>
11+
- arduino:web_ui

‎examples/bedtime-story-teller/assets/app.js‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// SPDX-FileCopyrightText: Copyright (C) 2025 ARDUINO SA <http://www.arduino.cc>
2+
//
3+
// SPDX-License-Identifier: MPL-2.0
4+
5+
/*
6+
* UI Elements definition: needed to interact with the HTML elements.
7+
*/
8+
9+
const socket = io(`http://${window.location.host}`); // Initialize socket.io connection
10+
11+
/*
12+
* Socket initialization. We need it to communicate with the server
13+
*/
14+
function initSocketIO() {
15+
socket.on('response', (data) => {
16+
const responseBox = document.getElementById('promptResponse');
17+
responseBox.textContent += data;
18+
responseBox.style.display = 'block';
19+
document.getElementById('loadingSpinner').style.display = 'none';
20+
document.getElementById('clearStoryButton').disabled = false;
21+
});
22+
}
23+
24+
// Start the application
25+
document.addEventListener('DOMContentLoaded', () => {
26+
initSocketIO();
27+
});
28+
29+
function generateStory(msg) {
30+
document.getElementById('sendStoryButton').disabled = true;
31+
document.getElementById('storyInput').disabled = true;
32+
document.getElementById('loadingSpinner').style.display = 'inline-block';
33+
socket.emit('generate_story', msg);
34+
}
35+
36+
function resetUI() {
37+
document.getElementById('storyInput').value = '';
38+
document.getElementById('promptResponse').style.display = 'none';
39+
document.getElementById('promptResponse').scrollTop = 0; // Reset scroll position
40+
document.getElementById('promptResponse').textContent = '';
41+
document.getElementById('sendStoryButton').disabled = false;
42+
document.getElementById('storyInput').disabled = false;
43+
}

‎examples/bedtime-story-teller/assets/fonts/Open Sans/OFL.txt‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright 2020 The Open Sans Project Authors (https://github.com/googlefonts/opensans)
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
https://openfontlicense.org
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎examples/bedtime-story-teller/assets/fonts/Open Sans/OpenSans-VariableFont_wdth,wght.ttf‎

517 KB
Binary file not shown.

‎examples/bedtime-story-teller/assets/fonts/Roboto/OFL.txt‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
2+
This license is copied below, and is also available with a FAQ at:
3+
https://openfontlicense.org
4+
5+
6+
-----------------------------------------------------------
7+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
8+
-----------------------------------------------------------
9+
10+
PREAMBLE
11+
The goals of the Open Font License (OFL) are to stimulate worldwide
12+
development of collaborative font projects, to support the font creation
13+
efforts of academic and linguistic communities, and to provide a free and
14+
open framework in which fonts may be shared and improved in partnership
15+
with others.
16+
17+
The OFL allows the licensed fonts to be used, studied, modified and
18+
redistributed freely as long as they are not sold by themselves. The
19+
fonts, including any derivative works, can be bundled, embedded,
20+
redistributed and/or sold with any software provided that any reserved
21+
names are not used by derivative works. The fonts and derivatives,
22+
however, cannot be released under any other type of license. The
23+
requirement for fonts to remain under this license does not apply
24+
to any document created using the fonts or their derivatives.
25+
26+
DEFINITIONS
27+
"Font Software" refers to the set of files released by the Copyright
28+
Holder(s) under this license and clearly marked as such. This may
29+
include source files, build scripts and documentation.
30+
31+
"Reserved Font Name" refers to any names specified as such after the
32+
copyright statement(s).
33+
34+
"Original Version" refers to the collection of Font Software components as
35+
distributed by the Copyright Holder(s).
36+
37+
"Modified Version" refers to any derivative made by adding to, deleting,
38+
or substituting -- in part or in whole -- any of the components of the
39+
Original Version, by changing formats or by porting the Font Software to a
40+
new environment.
41+
42+
"Author" refers to any designer, engineer, programmer, technical
43+
writer or other person who contributed to the Font Software.
44+
45+
PERMISSION & CONDITIONS
46+
Permission is hereby granted, free of charge, to any person obtaining
47+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
48+
redistribute, and sell modified and unmodified copies of the Font
49+
Software, subject to the following conditions:
50+
51+
1) Neither the Font Software nor any of its individual components,
52+
in Original or Modified Versions, may be sold by itself.
53+
54+
2) Original or Modified Versions of the Font Software may be bundled,
55+
redistributed and/or sold with any software, provided that each copy
56+
contains the above copyright notice and this license. These can be
57+
included either as stand-alone text files, human-readable headers or
58+
in the appropriate machine-readable metadata fields within text or
59+
binary files as long as those fields can be easily viewed by the user.
60+
61+
3) No Modified Version of the Font Software may use the Reserved Font
62+
Name(s) unless explicit written permission is granted by the corresponding
63+
Copyright Holder. This restriction only applies to the primary font name as
64+
presented to the users.
65+
66+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
67+
Software shall not be used to promote, endorse or advertise any
68+
Modified Version, except to acknowledge the contribution(s) of the
69+
Copyright Holder(s) and the Author(s) or with their explicit written
70+
permission.
71+
72+
5) The Font Software, modified or unmodified, in part or in whole,
73+
must be distributed entirely under this license, and must not be
74+
distributed under any other license. The requirement for fonts to
75+
remain under this license does not apply to any document created
76+
using the Font Software.
77+
78+
TERMINATION
79+
This license becomes null and void if any of the above conditions are
80+
not met.
81+
82+
DISCLAIMER
83+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
84+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
85+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
86+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
87+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
88+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
89+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
90+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
91+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎examples/bedtime-story-teller/assets/fonts/Roboto/RobotoMono-VariableFont_wght.ttf‎

177 KB
Binary file not shown.

‎examples/bedtime-story-teller/assets/fonts/fonts.css‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/*
2+
* SPDX-FileCopyrightText: Copyright (C) 2025 ARDUINO SA <http://www.arduino.cc>
3+
*
4+
* SPDX-License-Identifier: MPL-2.0
5+
*/
6+
7+
@font-face {
8+
font-family: 'Roboto Mono';
9+
font-style: normal;
10+
font-display: swap;
11+
src: url('Roboto/RobotoMono-VariableFont_wght.ttf') format('truetype');
12+
}
13+
14+
@font-face {
15+
font-family: 'Open Sans';
16+
font-style: normal;
17+
font-display: swap;
18+
src: url('Open Sans/OpenSans-VariableFont_wdth,wght.ttf') format('truetype');
19+
}

‎examples/bedtime-story-teller/assets/img/logo.svg‎

Lines changed: 19 additions & 0 deletions
Loading

‎examples/bedtime-story-teller/assets/img/storyteller-background.png‎

2.42 MB
Loading

0 commit comments

Comments
 (0)