dlouapre HF Staff commited on
Commit
832123d
·
1 Parent(s): ee6161a
Files changed (2) hide show
  1. INFO.md +95 -0
  2. README.md +7 -87
INFO.md ADDED
@@ -0,0 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ title: Rmscript App
2
+ emoji: 😻
3
+ colorFrom: red
4
+ colorTo: red
5
+ sdk: static
6
+ pinned: false
7
+ short_description: Testing the Reachy Mini Script language
8
+
9
+ # RMScript App
10
+
11
+ Web IDE for programming Reachy Mini with rmscript - a kid-friendly scripting language.
12
+
13
+ ## Features
14
+
15
+ - **Web-based editor** with syntax verification
16
+ - **Real-time compilation** to robot commands
17
+ - **Server-side execution** with proper timing and smooth movements
18
+ - **Example scripts** to get started quickly
19
+
20
+ ## Installation
21
+
22
+ ### From the Daemon Dashboard
23
+
24
+ 1. Open the Reachy Mini daemon dashboard at `http://localhost:8000`
25
+ 2. Navigate to the Apps section
26
+ 3. Search for "RMScript App" or paste this Space URL
27
+ 4. Click Install
28
+
29
+ ### Manual Installation
30
+
31
+ ```bash
32
+ pip install rmscript-app
33
+ ```
34
+
35
+ ## Usage
36
+
37
+ ### Running the App
38
+
39
+ After installation, start the app from the daemon dashboard or run directly:
40
+
41
+ ```bash
42
+ # Start the daemon first
43
+ reachy-mini-daemon --sim # or -p /dev/ttyUSB0 for real robot
44
+
45
+ # Run the app
46
+ python -m rmscript_app.main
47
+ ```
48
+
49
+ Then open `http://localhost:8042` in your browser.
50
+
51
+ ### Example Script
52
+
53
+ ```rmscript
54
+ "Wave hello"
55
+ look left
56
+ antenna both up
57
+ wait 1s
58
+ look right
59
+ antenna both down
60
+ wait 0.5s
61
+ look center
62
+ ```
63
+
64
+ ## RMScript Language
65
+
66
+ RMScript uses natural language commands:
67
+
68
+ - **Movement**: `look left`, `look right 45`, `turn left`
69
+ - **Antennas**: `antenna up`, `antenna both down`
70
+ - **Timing**: `wait 1s`, `wait 0.5s`
71
+ - **Loops**: `REPEAT 3 ... END`
72
+ - **Sounds**: `play soundname`
73
+ - **Camera**: `picture`
74
+
75
+ See the [rmscript documentation](../rmscript/README.md) for the full language reference.
76
+
77
+ ## Development
78
+
79
+ ```bash
80
+ # Clone and install in development mode
81
+ cd rmscript_app
82
+ pip install -e .
83
+
84
+ # Run the app
85
+ python -m rmscript_app.main
86
+ ```
87
+
88
+ ## Publishing to HuggingFace Spaces
89
+
90
+ ```bash
91
+ # Use the app assistant
92
+ reachy-mini-app-assistant publish rmscript_app/
93
+ ```
94
+
95
+ This creates a static Space that serves as a catalog entry. The actual app runs locally when installed via the daemon dashboard.
README.md CHANGED
@@ -1,87 +1,7 @@
1
- # RMScript App
2
-
3
- Web IDE for programming Reachy Mini with rmscript - a kid-friendly scripting language.
4
-
5
- ## Features
6
-
7
- - **Web-based editor** with syntax verification
8
- - **Real-time compilation** to robot commands
9
- - **Server-side execution** with proper timing and smooth movements
10
- - **Example scripts** to get started quickly
11
-
12
- ## Installation
13
-
14
- ### From the Daemon Dashboard
15
-
16
- 1. Open the Reachy Mini daemon dashboard at `http://localhost:8000`
17
- 2. Navigate to the Apps section
18
- 3. Search for "RMScript App" or paste this Space URL
19
- 4. Click Install
20
-
21
- ### Manual Installation
22
-
23
- ```bash
24
- pip install rmscript-app
25
- ```
26
-
27
- ## Usage
28
-
29
- ### Running the App
30
-
31
- After installation, start the app from the daemon dashboard or run directly:
32
-
33
- ```bash
34
- # Start the daemon first
35
- reachy-mini-daemon --sim # or -p /dev/ttyUSB0 for real robot
36
-
37
- # Run the app
38
- python -m rmscript_app.main
39
- ```
40
-
41
- Then open `http://localhost:8042` in your browser.
42
-
43
- ### Example Script
44
-
45
- ```rmscript
46
- "Wave hello"
47
- look left
48
- antenna both up
49
- wait 1s
50
- look right
51
- antenna both down
52
- wait 0.5s
53
- look center
54
- ```
55
-
56
- ## RMScript Language
57
-
58
- RMScript uses natural language commands:
59
-
60
- - **Movement**: `look left`, `look right 45`, `turn left`
61
- - **Antennas**: `antenna up`, `antenna both down`
62
- - **Timing**: `wait 1s`, `wait 0.5s`
63
- - **Loops**: `REPEAT 3 ... END`
64
- - **Sounds**: `play soundname`
65
- - **Camera**: `picture`
66
-
67
- See the [rmscript documentation](../rmscript/README.md) for the full language reference.
68
-
69
- ## Development
70
-
71
- ```bash
72
- # Clone and install in development mode
73
- cd rmscript_app
74
- pip install -e .
75
-
76
- # Run the app
77
- python -m rmscript_app.main
78
- ```
79
-
80
- ## Publishing to HuggingFace Spaces
81
-
82
- ```bash
83
- # Use the app assistant
84
- reachy-mini-app-assistant publish rmscript_app/
85
- ```
86
-
87
- This creates a static Space that serves as a catalog entry. The actual app runs locally when installed via the daemon dashboard.
 
1
+ title: Reachy Mini Script App
2
+ emoji: 🤖
3
+ colorFrom: red
4
+ colorTo: red
5
+ sdk: static
6
+ pinned: false
7
+ short_description: Testing the Reachy Mini Script language