[JS]
[DE]
[PLUGIN] ../../build/hacktimer.plugin
[PLUGIN] ../../build/jam.plugin
[PLUGIN] ../../build/popup.plugin
[PLUGIN] ../../build/file.plugin
[PLUGIN] ../../build/math.plugin
[TITLE] MCWS mit JAM 
[AUTHOR] Stefan Bosse
[VERSION] 8.2020

# Mobiles Crowdsensing mit JAM Agenten (mit Umfrage) - Version 2

## Einführung

### Vorbereitung

1. Starte die JAM WEB App [APP](https://ag-0.de/software/jamapp.html?link=ag-0.de:30001&secure=12:34:56:78&proto=https&sensors=gps5) im Browser (Smartphone, Dekstop Rechner, Notebook)
2. Optional für die Experimentierfreudigen: Starte einen Tor Browser mit Proxykette und lade auch dort die JAM WEB App
3. Die JAM WEB App muss nicht weiter bedient werden (ist hier nur Kommunikationsendpunkt)

## JAM Plattform Shell

[CODE] Eine Shell erzeugen { lines:10 }
```js
Shell({
  verbose:1
});
```

[JAM] Die Shell starten { lines:10 }
```js
port(DIR.IP('https://localhost:*'));
locate(print);
connect(DIR.IP('https://ag-0.de:30101?secure=12:34:56:78'));
start()
```

## Explorationsagent für Mobile Umfragen

- Der Explorationagent besucht über den Relaisknoten alle verbundenen Geräte (Smartphones, Notebooks, usw.) nach einander!

- Da die *JAM* Plattform im WEB Browser ausgeführt wird (Endgeräte), kann es passieren dass die Seite (App) mit einem oder mehreren Explorationsagenten "darin" geschlossen wird. Die Agenten sind verloren!

- Damit Zwischenergebnisse der Exploration gesichert werden repliziert sich der Explorationagent bevor er einen neuen Knoten besucht. 
  + Die Kopie enthält die aktuellen Erhebungsergebnisse. 
  + Die Kopie geht mit den aktuellen Teilergebnissen zurück zum Ursprungsknoten (also hier im Notebook) und liefert sie aus.

[JAM] Agent { lines:20 }
```js
function explorer (options) {
  // 1. Körpervariablen (Inhalte sind mobil)
  this.rootNode=null;
  this.visited=[];
  // Sensors of current node
  this.sensors={};
  // Hier werden alle Sensor- und Umfrageergebnisse gesammelt
  this.collect=[];
  this.verbose = 1;
  this.currentNode = null;
  this.path = [];
  this.nextNode = null;
  this.hops = 0;
  this.maxHops = 200;
  this.timeout = options.timeout||30000;
  
  this.todo = null;
  this.alreadyVisited = false;
  
  // Optional survey script
  this.survey = options.survey;
  // Dialog Map mit zusätzlichen Labelreferenzen
  this.dialog = null;
  this.index = 0;
  this.token = null;
  this.tokenTrials = 0;
  // Antworten werden zu this.sensors.answers hinzugefügt

// Dialog Label Mapper
  this.dialogMap = function (dialog) {
    var map={};
    iter(dialog,function (entry,index) {
      map[index]=entry;
      if (entry.label) map[entry.label]=entry;
    });
    return map;
  }

// 2. Aktivitäten
  this.act = {
    init : function () {
      this.rootNode = myNode();
      log('Starting on '+this.rootNode);
      this.path.push(this.rootNode);
      this.sensors={};
      if (this.survey) 
        this.dialog = this.dialogMap(this.survey.dialog);
    },

percept : function () {
      var loc,self=this;
      this.currentNode = myNode();
      log('PERCEPT on '+this.currentNode);
      this.tokenTrials=0;
      this.alreadyVisited=contains(this.visited,this.currentNode);
      if (!this.alreadyVisited) {
        // Neuer Knoten
        this.visited.push(this.currentNode);
        this.sensors = {};
        this.sensors.clock=clock(true);
        this.sensors.path=copy(this.path);
        this.sensors.node=this.currentNode;
        this.sensors.chat=test(['CHAT',_]);
        // Infos von der aktuellen Plattform?
          loc=info('node').location;
          if (loc && loc.gps) 
            this.sensors.gps=[loc.gps.lat,loc.gps.lon,'@IP'];
          loc=info('node').location;
          if (loc && loc.gps5) 
            this.sensors.gps5=[loc.gps5.lat,loc.gps5.lon];
          loc=info('node').location;
          if (loc && loc.geo)
            this.sensors.location=[loc.geo.city,
                              loc.geo.zip,
                              _,_,
                              loc.geo.country];
          loc=info('node').location;
          if (loc && loc.geo5)
            this.sensors.location5=[loc.geo5.city,
                               loc.geo5.zip,
                               loc.geo5.street,
                               loc.geo5.number,
                               loc.geo5.country];
        this.collect.push(this.sensors);
      } else this.sensors={};
      var next = filter(link(DIR.IP('%')),this.visited);
      if (next.length) {
      	// explore next node
        this.nextNode=random(next);
      } else {
      	// go one step back
        this.nextNode=null;
      }
    },

explore : function () {
      if (link(DIR.NODE(this.nextNode))) {
        log('GO to '+this.nextNode);
        this.hops++;
        this.path.push(this.nextNode);
      	moveto(DIR.NODE(this.nextNode));
      } else this.nextNode==null;
    },

////////////
    // Survey //
    ////////////
    sessionOpen : function () {      
      // get a session token
      log('Requesting session token..');
      mark(['CHAT-SESSION',me(),this.timeout*2],this.timeout);
      this.token = null;
      this.index = 0;
      this.sensors.answers={};
      inp.try(1000,['CHAT-TOKEN',me(),_],function (reply) {
        log('Got sesssion token?: '+reply);
        if (reply) this.token=reply[2];
        else {
          rm(['CHAT-SESSION',me(),_]);
          // try again..
          this.tokenTrials++;
        }
      });
    },
    sessionClose : function () {
      mark(['CHAT-SESSION',me(),0],this.timeout);
      this.sensors={};
    },
    ask: function () {
      var self=this;
      // ask next entry of the dialog script
      var index=this.index++;
      var next = copy(this.survey.dialog[index]);
      log(next.message||next.question);
      if (next.cond && !next.cond(this.dialog)) return;
      if (next.message && !next.question) {
        var msg=next.eval?
                this.replaceText(next.message,next.eval(this.dialog))
                :next.message;
      	mark(['CHAT-MESSAGE',me(),this.token,msg],this.timeout);
      } else if (next.question) {
         var msg=next.eval?
                this.replaceText(next.question,next.eval(this.dialog))
                :next.question;
        next.question=msg;
        if (next.choices)
          mark(['CHAT-QUESTION',me(),this.token,
                msg,{choices:next.choices}],this.timeout);
        else
          mark(['CHAT-QUESTION',me(),this.token,
                 next.question,{
                   type:next.range?'number':'text',
                   range:next.range,
                   value:next.value,
                 }],this.timeout)
        inp.try(this.timeout,['CHAT-ANSWER',me(),this.token,next.question,_],function (reply) {
           if (this.verbose) log('Got answer: '+reply);
           self.sensors.answers[next.label||index] =
           self.dialog[next.label||index].answer   =
             reply && reply[4] && (next.range?Number(reply[4]):reply[4]);
           if (!reply || reply[4]==undefined) { /*stop*/ 
             if (!self.survey.dialog[self.survey.dialog.length-1].question)
             self.index=self.survey.dialog.length-1;
             else self.index=1E9; 
           }
        })
      }
    },

plan : function () {
      if (this.nextNode && this.currentNode!=this.rootNode) {
        // bug: TR plan should be evaluated after forking
        //      but it is evaluated before forking??
       	var child=fork({todo:'goback',next:'goback',nextNode:null});
        log('FORKING notifier: '+child);
      }
    },
    
    goback : function () {
      var next = this.path.pop();
      if (next==this.currentNode) next = this.path.pop();
      if (next && link(DIR.NODE(next))) {
        log('GOBACK to '+next);
        this.hops++;
        this.path.push(next);
      	moveto(DIR.NODE(next));
      }
    },

deliver : function () {
      log('DELIVER '+this.collect.length);
      out(['COLLECT',me(),this.collect]);
    },

end : function () {
      log('END');
      kill();
    }
  }

// 3. Übergänge
  this.trans = {
    init : 'percept',
    percept : function () {
      return !this.alreadyVisited && this.sensors.chat && this.survey?sessionOpen:plan;
    },
    plan : function () {
      // log('TR PLAN '+this.todo);
      if (this.todo) return this.todo;
      if (!this.nextNode && this.path.length==0 && this.currentNode==this.rootNode)
        return 'deliver';
      if (this.hops==this.maxHops ||
          (!this.nextNode && this.path.length==0)) 
        return 'end';
      return this.nextNode?'explore':'goback';    
    },
    sessionOpen : function () {
      if (!this.token && this.tokenTrials < this.timeout) return sessionOpen;
      return this.token?ask:plan; 
    },
    sessionClose : plan,
    ask : function () {
      return this.index < this.survey.dialog.length?ask:sessionClose;
    },
    
    explore : 'percept',
    goback : function () {
      if (this.currentNode==this.rootNode) 
        return 'deliver';
      if (this.todo=='goback') return 'goback';
      return 'percept'
    },
    deliver:'end',
  }

this.on = {

}

// Erforderlich: Angabe der Startaktivität
  this.next = 'init';
}
// Die Agentenkosntruktionsfunktion prüfen und in dieser Plattform installieren
compile(explorer,{verbose:1})
```
## Die Umfrage

[CODE] Umfrage Beschreibung
```js
survey = {
  author : 'Student',
  // Ab hier kommt der Dialog:
  dialog : [
    {label:'QA', question: 'Wie alt sind Sie?', range:[1,99], step:1 },
    {label:'QF', question: 'Welche Speisen essen Sie?',
                 choices: ['vegetarisch',
                           'vegan',
                           'Fleisch',
                           'Fisch'],
                 cond: function (dialog) {
                   return dialog.QA.answer>=18
                 }},
    {label:'QL', question: 'Nennen Sie Ihre Lieblingsspeise:' },
    {message:'Danke!'},
  ],
}
print('Done.')
```

## Agent starten

[JAM] Agent { lines:20 }
```js
create('explorer',{
  survey:survey,
  timeout:60000,
},1);
```

### Ergebnisse abrufen

- Nachdem der Explorationsagent wieder hier zurück gekehrt ist (siehe Meldungen im Startfenster, `DELIVER #`) können die Ergebenisse aus dem Tupelraum entnommen werden

[JAM] Agent { lines:20 }
```js
var results = inp(['COLLECT',_,_]);
if (results) results=results[2];
global.results=results;
print(results);
```

### Ergebnisse darstellen

[CODE] Ergebnisse { lines:20 }
```js
var results = global.results.map(function (sample) {
  var sample=copy(sample);
  if (sample.answers) sample=Object.assign(sample,sample.answers);
  return sample;
});
Table(results,
      ['location','location5','gps','gps5','clock',
       'QA','QF','QL']);
```

### Ergebnisse speichern

[CODE] Speichern { lines:4 }
```js
if (typeof counter == 'undefined') counter=0;
counter++;
Save(global.results,'survey'+counter+'.json')
```

Mobiles Crowdsensing mit JAM Agenten (mit Umfrage) - Version 2

Einführung

Vorbereitung

Starte die JAM WEB App APP im Browser (Smartphone, Dekstop Rechner, Notebook)
Optional für die Experimentierfreudigen: Starte einen Tor Browser mit Proxykette und lade auch dort die JAM WEB App
Die JAM WEB App muss nicht weiter bedient werden (ist hier nur Kommunikationsendpunkt)

JAM Plattform Shell

Eine Shell erzeugen

Shell({
  verbose:1
});

▸

✗

Die Shell starten

port(DIR.IP('https://localhost:*'));
locate(print);
connect(DIR.IP('https://ag-0.de:30101?secure=12:34:56:78'));
start()

▸

✗

Explorationsagent für Mobile Umfragen

Der Explorationagent besucht über den Relaisknoten alle verbundenen Geräte (Smartphones, Notebooks, usw.) nach einander!
Da die JAM Plattform im WEB Browser ausgeführt wird (Endgeräte), kann es passieren dass die Seite (App) mit einem oder mehreren Explorationsagenten "darin" geschlossen wird. Die Agenten sind verloren!
Damit Zwischenergebnisse der Exploration gesichert werden repliziert sich der Explorationagent bevor er einen neuen Knoten besucht.
- Die Kopie enthält die aktuellen Erhebungsergebnisse.
- Die Kopie geht mit den aktuellen Teilergebnissen zurück zum Ursprungsknoten (also hier im Notebook) und liefert sie aus.

Agent

function explorer (options) {
  // 1. Körpervariablen (Inhalte sind mobil)
  this.rootNode=null;
  this.visited=[];
  // Sensors of current node
  this.sensors={};
  // Hier werden alle Sensor- und Umfrageergebnisse gesammelt
  this.collect=[];
  this.verbose = 1;
  this.currentNode = null;
  this.path = [];
  this.nextNode = null;
  this.hops = 0;
  this.maxHops = 200;
  this.timeout = options.timeout||30000;

  this.todo = null;
  this.alreadyVisited = false;

  // Optional survey script
  this.survey = options.survey;
  // Dialog Map mit zusätzlichen Labelreferenzen
  this.dialog = null;
  this.index = 0;
  this.token = null;
  this.tokenTrials = 0;
  // Antworten werden zu this.sensors.answers hinzugefügt

  // Dialog Label Mapper
  this.dialogMap = function (dialog) {
    var map={};
    iter(dialog,function (entry,index) {
      map[index]=entry;
      if (entry.label) map[entry.label]=entry;
    });
    return map;
  }

  // 2. Aktivitäten
  this.act = {
    init : function () {
      this.rootNode = myNode();
      log('Starting on '+this.rootNode);
      this.path.push(this.rootNode);
      this.sensors={};
      if (this.survey) 
        this.dialog = this.dialogMap(this.survey.dialog);
    },

    percept : function () {
      var loc,self=this;
      this.currentNode = myNode();
      log('PERCEPT on '+this.currentNode);
      this.tokenTrials=0;
      this.alreadyVisited=contains(this.visited,this.currentNode);
      if (!this.alreadyVisited) {
        // Neuer Knoten
        this.visited.push(this.currentNode);
        this.sensors = {};
        this.sensors.clock=clock(true);
        this.sensors.path=copy(this.path);
        this.sensors.node=this.currentNode;
        this.sensors.chat=test(['CHAT',_]);
        // Infos von der aktuellen Plattform?
          loc=info('node').location;
          if (loc && loc.gps) 
            this.sensors.gps=[loc.gps.lat,loc.gps.lon,'@IP'];
          loc=info('node').location;
          if (loc && loc.gps5) 
            this.sensors.gps5=[loc.gps5.lat,loc.gps5.lon];
          loc=info('node').location;
          if (loc && loc.geo)
            this.sensors.location=[loc.geo.city,
                              loc.geo.zip,
                              _,_,
                              loc.geo.country];
          loc=info('node').location;
          if (loc && loc.geo5)
            this.sensors.location5=[loc.geo5.city,
                               loc.geo5.zip,
                               loc.geo5.street,
                               loc.geo5.number,
                               loc.geo5.country];
        this.collect.push(this.sensors);
      } else this.sensors={};
      var next = filter(link(DIR.IP('%')),this.visited);
      if (next.length) {
      	// explore next node
        this.nextNode=random(next);
      } else {
      	// go one step back
        this.nextNode=null;
      }
    },

    explore : function () {
      if (link(DIR.NODE(this.nextNode))) {
        log('GO to '+this.nextNode);
        this.hops++;
        this.path.push(this.nextNode);
      	moveto(DIR.NODE(this.nextNode));
      } else this.nextNode==null;
    },

    ////////////
    // Survey //
    ////////////
    sessionOpen : function () {      
      // get a session token
      log('Requesting session token..');
      mark(['CHAT-SESSION',me(),this.timeout*2],this.timeout);
      this.token = null;
      this.index = 0;
      this.sensors.answers={};
      inp.try(1000,['CHAT-TOKEN',me(),_],function (reply) {
        log('Got sesssion token?: '+reply);
        if (reply) this.token=reply[2];
        else {
          rm(['CHAT-SESSION',me(),_]);
          // try again..
          this.tokenTrials++;
        }
      });
    },
    sessionClose : function () {
      mark(['CHAT-SESSION',me(),0],this.timeout);
      this.sensors={};
    },
    ask: function () {
      var self=this;
      // ask next entry of the dialog script
      var index=this.index++;
      var next = copy(this.survey.dialog[index]);
      log(next.message||next.question);
      if (next.cond && !next.cond(this.dialog)) return;
      if (next.message && !next.question) {
        var msg=next.eval?
                this.replaceText(next.message,next.eval(this.dialog))
                :next.message;
      	mark(['CHAT-MESSAGE',me(),this.token,msg],this.timeout);
      } else if (next.question) {
         var msg=next.eval?
                this.replaceText(next.question,next.eval(this.dialog))
                :next.question;
        next.question=msg;
        if (next.choices)
          mark(['CHAT-QUESTION',me(),this.token,
                msg,{choices:next.choices}],this.timeout);
        else
          mark(['CHAT-QUESTION',me(),this.token,
                 next.question,{
                   type:next.range?'number':'text',
                   range:next.range,
                   value:next.value,
                 }],this.timeout)
        inp.try(this.timeout,['CHAT-ANSWER',me(),this.token,next.question,_],function (reply) {
           if (this.verbose) log('Got answer: '+reply);
           self.sensors.answers[next.label||index] =
           self.dialog[next.label||index].answer   =
             reply && reply[4] && (next.range?Number(reply[4]):reply[4]);
           if (!reply || reply[4]==undefined) { /*stop*/ 
             if (!self.survey.dialog[self.survey.dialog.length-1].question)
             self.index=self.survey.dialog.length-1;
             else self.index=1E9; 
           }
        })
      }
    },

    plan : function () {
      if (this.nextNode && this.currentNode!=this.rootNode) {
        // bug: TR plan should be evaluated after forking
        //      but it is evaluated before forking??
       	var child=fork({todo:'goback',next:'goback',nextNode:null});
        log('FORKING notifier: '+child);
      }
    },

    goback : function () {
      var next = this.path.pop();
      if (next==this.currentNode) next = this.path.pop();
      if (next && link(DIR.NODE(next))) {
        log('GOBACK to '+next);
        this.hops++;
        this.path.push(next);
      	moveto(DIR.NODE(next));
      }
    },

    deliver : function () {
      log('DELIVER '+this.collect.length);
      out(['COLLECT',me(),this.collect]);
    },

    end : function () {
      log('END');
      kill();
    }
  }

  // 3. Übergänge
  this.trans = {
    init : 'percept',
    percept : function () {
      return !this.alreadyVisited && this.sensors.chat && this.survey?sessionOpen:plan;
    },
    plan : function () {
      // log('TR PLAN '+this.todo);
      if (this.todo) return this.todo;
      if (!this.nextNode && this.path.length==0 && this.currentNode==this.rootNode)
        return 'deliver';
      if (this.hops==this.maxHops ||
          (!this.nextNode && this.path.length==0)) 
        return 'end';
      return this.nextNode?'explore':'goback';    
    },
    sessionOpen : function () {
      if (!this.token && this.tokenTrials < this.timeout) return sessionOpen;
      return this.token?ask:plan; 
    },
    sessionClose : plan,
    ask : function () {
      return this.index < this.survey.dialog.length?ask:sessionClose;
    },

    explore : 'percept',
    goback : function () {
      if (this.currentNode==this.rootNode) 
        return 'deliver';
      if (this.todo=='goback') return 'goback';
      return 'percept'
    },
    deliver:'end',
  }

  this.on = {

  }

  // Erforderlich: Angabe der Startaktivität
  this.next = 'init';
}
// Die Agentenkosntruktionsfunktion prüfen und in dieser Plattform installieren
compile(explorer,{verbose:1})

▸

✗

Die Umfrage

Umfrage Beschreibung

survey = {
  author : 'Student',
  // Ab hier kommt der Dialog:
  dialog : [
    {label:'QA', question: 'Wie alt sind Sie?', range:[1,99], step:1 },
    {label:'QF', question: 'Welche Speisen essen Sie?',
                 choices: ['vegetarisch',
                           'vegan',
                           'Fleisch',
                           'Fisch'],
                 cond: function (dialog) {
                   return dialog.QA.answer>=18
                 }},
    {label:'QL', question: 'Nennen Sie Ihre Lieblingsspeise:' },
    {message:'Danke!'},
  ],
}
print('Done.')

▸

✗

Agent starten

Agent

create('explorer',{
  survey:survey,
  timeout:60000,
},1);

▸

✗

Ergebnisse abrufen

Nachdem der Explorationsagent wieder hier zurück gekehrt ist (siehe Meldungen im Startfenster, DELIVER #) können die Ergebenisse aus dem Tupelraum entnommen werden

Agent

var results = inp(['COLLECT',_,_]);
if (results) results=results[2];
global.results=results;
print(results);

▸

✗

Ergebnisse darstellen

Ergebnisse

var results = global.results.map(function (sample) {
  var sample=copy(sample);
  if (sample.answers) sample=Object.assign(sample,sample.answers);
  return sample;
});
Table(results,
      ['location','location5','gps','gps5','clock',
       'QA','QF','QL']);

▸

✗

Ergebnisse speichern

Speichern

if (typeof counter == 'undefined') counter=0;
counter++;
Save(global.results,'survey'+counter+'.json')

▸

✗

Created by the NoteBook Compiler Ver. 1.3.9 (c) Dr. Stefan Bosse (Sun Aug 02 2020 17:52:21 GMT+0200 (CET))