OrgGo
/
hybridgroup.gobot
mirror of https://github.com/hybridgroup/gobot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update params info for Robot 

Signed-off-by: deadprogram <ron@hybridgroup.com>
This commit is contained in:
deadprogram 2017-02-10 12:02:25 +01:00
parent 74d9dc4f5c
commit 804344873c
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
robot.go
View File

@ -94,12 +94,13 @@ func (r *Robots) Each(f func(*Robot)) {
}
}
// NewRobot returns a new Robot given optional accepts:
// NewRobot returns a new Robot. It supports the following optional params:
//
// name: string with the name of the Robot. A name will be automatically generated if no name is supplied.
// []Connection: Connections which are automatically started and stopped with the robot
// []Device: Devices which are automatically started and stopped with the robot
// func(): The work routine the robot will execute once all devices and connections have been initialized and started
// A name will be automaically generated if no name is supplied.
// []Device: Devices which are automatically started and stopped with the robot
// func(): The work routine the robot will execute once all devices and connections have been initialized and started
//
func NewRobot(v ...interface{}) *Robot {
r := &Robot{
Name: fmt.Sprintf("%X", Rand(int(^uint(0)>>1))),