OrgGo/hybridgroup.gobot
1
0
Fork 0
mirror of https://github.com/hybridgroup/gobot.git synced 2025-05-02 22:17:12 +08:00
Code Issues Projects Releases Wiki Activity

particle: update docs to match latest API

Browse Source 
Signed-off-by: deadprogram <ron@hybridgroup.com>
This commit is contained in:
deadprogram 2016-11-06 10:46:34 +01:00
parent 9faf9eb52a
commit 4e6a49aabf
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
platforms/particle/README.md
View File

@ -1,6 +1,6 @@
# Particle # Particle
The Particle Photon is a Wi-Fi connected microcontroller from Particle (http://particle.io), the company formerly known as Spark Devices. Once it connects to a Wi-Fi network, it automatically connects with a central server (the "Particle Cloud") and stays connected so it can be controlled from external systems, such as a Gobot program. To run gobot programs please make sure you are running default tinker firmware on the Photon. The Particle Photon and Particle Electron are connected microcontrollers from Particle (http://particle.io), the company formerly known as Spark Devices. The Photon uses a Wi-Fi connection to the Particle cloud, and the Electron uses a 3G wireless connection. Once the Photon or Electron connects to the network, it automatically connects with a central server (the "Particle Cloud") and stays connected so it can be controlled from external systems, such as a Gobot program. To run Gobot programs please make sure you are running default Tinker firmware on the Photon or Electron.
For more info about the Particle platform go to https://www.particle.io/ For more info about the Particle platform go to https://www.particle.io/
@ -36,7 +36,7 @@ func main() {
} }
robot := gobot.NewRobot("spark", robot := gobot.NewRobot("spark",
[]gobot.Connection{sparkCore}, []gobot.Connection{core},
[]gobot.Device{led}, []gobot.Device{led},
work, work,
) )

24
platforms/particle/adaptor.go
View File

@ -36,7 +36,7 @@ var eventSource = func(url string) (chan eventsource.Event, chan error, error) {
} }
// NewAdaptor creates new Photon adaptor with deviceId and accessToken // NewAdaptor creates new Photon adaptor with deviceId and accessToken
// using api.spark.io server as default // using api.particle.io server as default
func NewAdaptor(deviceID string, accessToken string) *Adaptor { func NewAdaptor(deviceID string, accessToken string) *Adaptor {
return &Adaptor{ return &Adaptor{
name: "Particle", name: "Particle",
@ -50,17 +50,17 @@ func NewAdaptor(deviceID string, accessToken string) *Adaptor {
func (s *Adaptor) Name() string { return s.name } func (s *Adaptor) Name() string { return s.name }
func (s *Adaptor) SetName(n string) { s.name = n } func (s *Adaptor) SetName(n string) { s.name = n }
// Connect returns true if connection to spark core is successfull // Connect returns true if connection to Particle Photon or Electron is successful
func (s *Adaptor) Connect() (errs []error) { func (s *Adaptor) Connect() (errs []error) {
return return
} }
// Finalize returns true if connection to spark core is finalized successfully // Finalize returns true if connection to Particle Photon or Electron is finalized successfully
func (s *Adaptor) Finalize() (errs []error) { func (s *Adaptor) Finalize() (errs []error) {
return return
} }
// AnalogRead reads analog ping value using spark cloud api // AnalogRead reads analog ping value using Particle cloud api
func (s *Adaptor) AnalogRead(pin string) (val int, err error) { func (s *Adaptor) AnalogRead(pin string) (val int, err error) {
params := url.Values{ params := url.Values{
"params": {pin}, "params": {pin},
@ -83,7 +83,7 @@ func (s *Adaptor) PwmWrite(pin string, level byte) (err error) {
return s.AnalogWrite(pin, level) return s.AnalogWrite(pin, level)
} }
// AnalogWrite writes analog pin with specified level using spark cloud api // AnalogWrite writes analog pin with specified level using Particle cloud api
func (s *Adaptor) AnalogWrite(pin string, level byte) (err error) { func (s *Adaptor) AnalogWrite(pin string, level byte) (err error) {
params := url.Values{ params := url.Values{
"params": {fmt.Sprintf("%v,%v", pin, level)}, "params": {fmt.Sprintf("%v,%v", pin, level)},
@ -94,7 +94,7 @@ func (s *Adaptor) AnalogWrite(pin string, level byte) (err error) {
return return
} }
// DigitalWrite writes to a digital pin using spark cloud api // DigitalWrite writes to a digital pin using Particle cloud api
func (s *Adaptor) DigitalWrite(pin string, level byte) (err error) { func (s *Adaptor) DigitalWrite(pin string, level byte) (err error) {
params := url.Values{ params := url.Values{
"params": {fmt.Sprintf("%v,%v", pin, s.pinLevel(level))}, "params": {fmt.Sprintf("%v,%v", pin, s.pinLevel(level))},
@ -105,7 +105,7 @@ func (s *Adaptor) DigitalWrite(pin string, level byte) (err error) {
return err return err
} }
// DigitalRead reads from digital pin using spark cloud api // DigitalRead reads from digital pin using Particle cloud api
func (s *Adaptor) DigitalRead(pin string) (val int, err error) { func (s *Adaptor) DigitalRead(pin string) (val int, err error) {
params := url.Values{ params := url.Values{
"params": {pin}, "params": {pin},
@ -122,10 +122,10 @@ func (s *Adaptor) DigitalRead(pin string) (val int, err error) {
// EventStream returns a gobot.Event based on the following params: // EventStream returns a gobot.Event based on the following params:
// //
// * source - "all"/"devices"/"device" (More info at: http://docs.spark.io/api/#reading-data-from-a-core-events) // * source - "all"/"devices"/"device" (More info at: http://docs.particle.io/api/#reading-data-from-a-core-events)
// * name - Event name to subscribe for, leave blank to subscribe to all events. // * name - Event name to subscribe for, leave blank to subscribe to all events.
// //
// A new event is emitted as a spark.Event struct // A new event is emitted as a particle.Event struct
func (s *Adaptor) EventStream(source string, name string) (event *gobot.Event, err error) { func (s *Adaptor) EventStream(source string, name string) (event *gobot.Event, err error) {
var url string var url string
@ -202,12 +202,12 @@ func (s *Adaptor) Function(name string, args string) (val int, err error) {
return return
} }
// setAPIServer sets spark cloud api server, this can be used to change from default api.spark.io // setAPIServer sets Particle cloud api server, this can be used to change from default api.spark.io
func (s *Adaptor) setAPIServer(server string) { func (s *Adaptor) setAPIServer(server string) {
s.APIServer = server s.APIServer = server
} }
// deviceURL constructs device url to make requests from spark cloud api // deviceURL constructs device url to make requests from Particle cloud api
func (s *Adaptor) deviceURL() string { func (s *Adaptor) deviceURL() string {
if len(s.APIServer) <= 0 { if len(s.APIServer) <= 0 {
s.setAPIServer("https://api.particle.io") s.setAPIServer("https://api.particle.io")
@ -247,7 +247,7 @@ func (s *Adaptor) request(method string, url string, params url.Values) (m map[s
json.Unmarshal(buf, &m) json.Unmarshal(buf, &m)
if resp.Status != "200 OK" { if resp.Status != "200 OK" {
err = fmt.Errorf("%v: error communicating to the spark cloud", resp.Status) err = fmt.Errorf("%v: error communicating to the Particle cloud", resp.Status)
} else if _, ok := m["error"]; ok { } else if _, ok := m["error"]; ok {
err = errors.New(m["error"].(string)) err = errors.New(m["error"].(string))
} }

6
platforms/particle/doc.go
View File

@ -1,9 +1,9 @@
/* /*
Package spark provides the Gobot adaptor for the Spark Core. Package particle provides the Gobot adaptor for the Particle Photon and Electron.
Installing: Installing:
go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/spark go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/particle
Example: Example:
@ -27,7 +27,7 @@ Example:
}) })
} }
robot := gobot.NewRobot("spark", robot := gobot.NewRobot("particle",
[]gobot.Connection{core}, []gobot.Connection{core},
[]gobot.Device{led}, []gobot.Device{led},
work, work,