Skip to content

Commit efa2921

Browse files
Update README.md
1 parent 757cf09 commit efa2921

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Animated Solitaries Library
1+
# Pepper Solitaries Loop Library
22

33
This Android Library allows you to create a solitaries animations loop. A solitary animation is an animation that the robot
44
runs when it's alone to attract people.
@@ -7,7 +7,7 @@ With this library, you can also define at which frequency you want the animation
77
to 60 seconds. **We advise you to not set this value below 30 seconds** or it may result in complains about robot being noisy
88
and impossible to reach.
99

10-
The solitaries animation loop can then be started and stopped whenever you want.
10+
The solitaries animations loop can then be started and stopped whenever you want.
1111

1212
## Getting Started
1313

@@ -41,24 +41,24 @@ Initialise the QiSDK in the onCreate. If you are unsure how to do this, refer to
4141
```
4242
QiSDK.register(this, this)
4343
```
44-
In the `onRobotFocusGained`, instantiate a `AnimatedSolitary` object by passing it the QiContext and start the loop:
44+
In the `onRobotFocusGained`, instantiate a `SolitariesLoop` object by passing it the QiContext and start the loop:
4545
```
46-
animatedSolitary = AnimatedSolitary(qiContext)
46+
solitariesLoop = SolitariesLoop(qiContext)
4747
```
4848
You can also define the frequency at which you want the animations to run (time in seconds):
4949
```
50-
animatedSolitary = AnimatedSolitary(qiContext, 40)
50+
solitariesLoop = SolitariesLoop(qiContext, 40)
5151
```
5252
Start the solitaries loop whenever you want (for instance if no human has been detected around the robot for X minutes):
5353
```
54-
animatedSolitary.start()
54+
solitariesLoop.start()
5555
```
5656
Stop the solitaries loop whenever you want (for instance if a human is engaged or if you loose the robot focus):
5757
```
58-
animatedSolitary.stop()
58+
solitariesLoop.stop()
5959
```
6060

6161

6262
## License
6363

64-
This project is licensed under the BSD 3-Clause "New" or "Revised" License. See the [LICENSE](LICENSE.md) file for details.
64+
This project is licensed under the BSD 3-Clause "New" or "Revised" License. See the [LICENSE](LICENSE.md) file for details.

0 commit comments

Comments
 (0)