Skip to content

Dro's modifications to the default robotstreamer repository.

License

Notifications You must be signed in to change notification settings

The-Dro/robotstreamer

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Robot Control Code For Connecting to RobotStreamer.com


Note: We have a discord group here with a technical support channel if you have any questions: https://discord.gg/syRQN7B

RobotStreamer is a unique streaming platform that allows users to interact not only with traditional video streams but through low latency telepresence. This is a new concept enabling the viewers of the stream to join the action through the "body" of a robot. So at a technical level, RobotStreamer is a robot control network and low latency live streaming platform. You can stream from a robot (typically a mobile robot with camera connected by wifi) or from a traditional camera. Yes that means you can stream whatever kind of live video you want on here. Yo can use a standard camera to stream, and we do support OBS. Also, you can buy robots from robotstreamer.com's store or make your own if you want the fully immersive robot (telepresence) stream.

Connect your movable cameras with TTS (robots) to RobotStreamer.com. We're a new project but already have interest from top live streamers like Ice Poseidon for robot camera control with massive numbers of users.

Broadcasters make the rules for their channels. Unlike most platforms, RobotStreamer is open to just about any content. Edgy stuff is welcome here. It is the internet after all. Just maintain basic ethical decency, keep it legal, and keep it entertaining. For language, it's up to the broadcaster to decide how they want to moderate if at all.

You can create streams with Robots (movable cameras with TTS), that's our specialty, and you can also create tradional live IRL streams or game streams from the desktop. We currently use a different protocol than most live streaming platforms for lower latency.

We have a system called funbits that lets the streamers monetize their streams.

How to contribute

Making your own live stream or robot? We'd like to hear from you. Join our discord and let us know what you are interested in doing. https://discord.gg/n6B7ymy

RobotStreamer lets you set up either a Desktop Stream or a Robot Stream, here's how to do each:

Desktop Live Stream: Installation

There are two ways to stream from your Desktop to RobotStreamer:

On desktop, you can stream using OBS and ffmpeg, follow instructions here:

Win:

https://github.com/robotstreamer/robotstreamer_win_obs

Mac:

https://github.com/robotstreamer/robotstreamer_mac_obs

You can also stream directly using just ffmpeg although you may have issues with quality. Use instructions below but send_video_windows.py rather than just send_video.

Note that you'll want to visit the discord for questions and such. Streaming from Desktop is still a beta feature. https://discord.gg/n6B7ymy

Doing device interface customization

Look at the python files with "interface" in the name to see how to connect your custom device.

Robot Live Stream: Installation

RobotStreamer runs some software on your robot to connect to the server and send audio/video streams. If you'd like to order a robot, contact rick at rick@robotstreamer.com or you can make your own.

Some information about typical robots on this system: http://www.robotstreamer.com/robots.html

We typically test with Raspberry Pi on Raspian but you can use other hardware and OS's also if you know what you are doing.

Installation:

Copy this into the terminal, and follow the instructions. This script has been tested on a Raspberry Pi 3, with a fresh flash of raspian stretch.

For Raspian Stretch:

sudo wget https://raw.githubusercontent.com/robotstreamer/robotstreamer/master/scripts/install.sh -O /tmp/install.sh && bash /tmp/install.sh

For Ubuntu 17.10 or later:

sudo wget https://raw.githubusercontent.com/robotstreamer/robotstreamer/master/scripts/install_ubuntu.sh -O /tmp/install_ubuntu.sh && bash /tmp/install_ubuntu.sh

To install your need your id's and keys to connect to robotstreamer.com. After logging in to website (and registering if needed), create your robot entry by going here. Fill in robot name and submit. The result will tell you your robot id, camera id, and stream key. http://robotstreamer.com/new_stream.html

During installation, you will be prompted for a robot id and camera id.

After installaction, you need to set the --stream-key parameter for send_video.py and for controller.py in the file "/home/pi/start_robot"

For example:

python controller.py --stream-key YOURKEYHERE ...
python send_video.py --stream-key YOURKEYHERE ...

To edit your start_robot file, put this into the terminal.

sudo nano /home/pi/start_robot

Manual Install

Installing robot control and video scripts

The RasPi will need the following things install so it can talk to your motor and talk to the internet.

(1) Install motor HAT software:

(2) Install python serial, gnutls, python-dev, espeak, and python-smbus:

apt-get install python-serial python-dev libgnutls28-dev espeak python-smbus python-pip git

(3) Install socket.io client for python:

pip install socketIO-client

(4) Install FFmpeg sudo apt-get install ffmpeg

Robot Stream: Bring your Bot to life: Programs to run on the Raspberry Pi

Start by cloning the robotstreamer repository

cd ~
git clone https://github.com/robotstreamer/robotstreamer
cd robotstreamer

Go to new robot page to create a robot. If you already have one, got to manage robots. There you'll find your Robot ID and Camera ID.

These two scripts need to be running in the background to bring your robot to life: controller.py, send_video.py. Here are instructions about how to start them.

Copy the 'start_robot' Script from robotstreamer/Scripts to the pi home folder

cp ~/robotstreamer/scripts/start_robot ~/

Edit the script so you can adjust some settings for controller.py and send_video.py:

nano ~/start_robot

Edit the YOURROBOTID to your robot ID.

Edit the YOURCAMERAID to your camera ID.

You are getting both IDs when you are creating a new bot on the website.

The second parameter on send_video.py 0 is assuming you have one camera plugged into your Pi and you are using it, which is usually the case.

There are more parameter possible for controller.py:

robot_id

Your Robot ID. Required

--env prod | dev

Environment for example dev or prod | default='prod'

--type motor_hat | serial | l298n | motozero

What type of motor controller should be used | default='motor_hat'

--serial-device /dev/ttyACM0

Serial device | default='/dev/ttyACM0'

--male

Use TTS with a male voice

--female

Use TTS with a female voice

--voice-number 1

What voice should be used | default=1

--led max7219

What LEDs should be used (if any) | default=none

--ledrotate 180

Rotates the LED matrix | default=none

Example start_robot:

cd /home/pi/robotstreamer
nohup scripts/repeat_start python controller.py YOURROBOTID --type motor_hat --male --voice-number 1 --led max7219 --ledrotate 180 &> /dev/null &
nohup scripts/repeat_start python send_video.py YOURCAMERAID 0 &> /dev/null &

Start script on boot

Use crontab to start the start_robot script on booting:
crontab -e

insert following line and save:

@reboot /bin/bash /home/pi/start_robot

When you reboot, that line should cause start_robot to run.

How to set robot type

Edit the start_robot file: nano ~/start_robot

You will see a line that looks something like this. Note this is just an example, yours will be different because of keys and any parameters you already have.

nohup scripts/repeat_start /usr/local/bin/python3.6 -u controller.py 100 --tts-volume 100 --straight-speed 180 --stream-key THISISAKEY1 &> /dev/null&

Use the --type parameter to set the type of robot, for example if you have a roomba: --type open_roomba

So, for this example, the line would then be:

nohup scripts/repeat_start /usr/local/bin/python3.6 -u controller.py 100 --type open_roomba --tts-volume 100 --straight-speed 180 --stream-key THISISAKEY1 &> /dev/null&

After editing the file, save and restart the pi.

Recommended Hardware

It's good to have a webcam with a mic for the robot. Stardard USB cams should work. Here are some tips on choosing hardware:

Don't use a Logitech C270 because it will have intermittent audio issues.

Don't use a Logitech C920 because you have have to unplug it and plug it back in to USB every time you restart to make it work.

We've verified that an Aluretek AWCL05F works for audio and video.

How to figure out problems if it's not starting the video feed

First run this script to kill all the processess running: /home/pi/robotstreamer/scripts/kill_command

Now in your robotstreamer directory (/home/pi/robostreamer), start up send_video with a command like this: /usr/bin/python3 send_video.py YOURCAMERAID 0 --stream-key YOURKEY --ffmpeg-path /usr/bin/ffmpeg

You'll need to use your stream key and you may need to adjust your path to ffmpeg. You can find it by using the command "which ffmpeg".

How to add sounds

Save 16 bit wav file in /home/pi/sound folder and it has to be all c

tal letters even the file extension.

For example: SOUND1.WAV

Another example: SOUND25.WAV

Has to be exactly like that but number can be different.

Then set command in your button config json text in your robot settings like SOUND1 or SOUND25

Have to use the word SOUND for it to know it's a sound.

Hardware Compatibility

Adafruit Motor Hat

Serial Port based commands

GoPiGo

Missing something?, you can add it, open source!

Instructions for Specific Hardward Configurations

GoPiGo3

For GoPiGo3, you will need to install the gopigo3 python module (which is different than older versions). It will need to be installed with the installation script from Dexter. Also, PYTHONPATH needs to be set to "/home/pi/Dexter/GoPiGo3/Software/Python"

Refer to this: https://github.com/DexterInd/GoPiGo3

sudo git clone http://www.github.com/DexterInd/GoPiGo3.git /home/pi/Dexter/GoPiGo3
sudo bash /home/pi/Dexter/GoPiGo3/Install/install.sh
sudo reboot

If you need to update the firmware:

cd Dexter/GoPiGo3/Firmware
chmod +x gopigo3_flash_firmware.sh
./gopigo3_flash_firmware.sh

Reference:

https://www.dexterindustries.com/GoPiGo/get-started-with-the-gopigo3-raspberry-pi-robot/test-and-troubleshoot-the-gopigo3-raspberry-pi-robot/

How Does This Work

The robot communicates with our control server via websockets. It communicates with our audio and video stream servers via http stream. Users connect to our servers.

The robot client connects via websockets to the API service to retrieve configuration information, to the chat to receive chat messages, the video/audio relays to send its camera and microphone capture, and to the control service to receive user commands.

Interfaces:

Control server via websockets Chat server via websockets Sends video stream via websockets Sends audio stream via websockets

Responsibilities:

Capturing Audio and Video Relays commands to robot hardware Text to Speech Supports remote login for diagnostics and updates Configuration updates from the web client (partially implemented)

Detailed Description:

The robot client connects to four external services: API Service, Chat Service, Video/Audio Service, and the Control Service.

API Service

Provides information about which host and port to connect to for the chat service, video/audio service, and control service

Chat Service

Relays chat messages sent from the web clients to the robot

Video/Audio Service

The robot client streams ffmpeg output to the video/audio service

Control Service

Relays control messages sent from the web clients to the robot

_

About

Dro's modifications to the default robotstreamer repository.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 88.2%
  • Shell 11.7%
  • Batchfile 0.1%