6. Kuulutaja kood

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

Alustame faili kolme tekstirea lisamisest (need on kirjas ülal).

Kõigepealt peame ROSile teada andma, kust leida Pythoni koodifailide käivitamiseks vajalik programm. Selleks lisame faili esimesele reale spetsiaalse kommentaari #!/usr/bin/env python3.

Järgmiseks peame importima kaks moodulit. Esimene neist on rospy – see lubab meil kirjutada Pythonis ROSi koodi. Viimaseks impordime sõnumitüübi Twist, kuna soovime kuulutama hakata just seda tüüpi sõnumeid.

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

rospy.init_node("velocity_publisher")

Et meie Pythoni koodist saaks ROSi sõlm, tuleb ta sõlmena lähtestada ehk initsialiseerida. Koodis saame seda teha, kutsudes välja initsialiseerimise funktsiooni rospy.init_node ja andes sellele argumendiks sõlme soovitud nime, näiteks velocity_publisher.

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

rospy.init_node("velocity_publisher")
velocity_pub = rospy.Publisher("cmd_vel", Twist, queue_size=0)
rospy.sleep(2)

Kuna robotile liikumiskäskude edastamiseks tuleb meil asuda kuulutama Twist-tüüpi sõnumeid rubriigis cmd_vel, siis järgmiseks lisamegi oma loodud sõlmele ühe kuulutaja. (Võime kuulutajast mõelda kui uuest muutujast, millel tuleb anda ka nimi, antud juhul anname kuulutajale nimeks velocity_pub.) Kuulutaja tegemiseks kasutame  funktsiooni Publisher, mis asub rospy moodulis. See funktsioon ootab sisendina kolme argumenti: rubriigi nime, milles soovime kuulutada, sõnumitüüpi, mis kirjeldab selles rubriigis kuulutatavaid sõnumeid, ja järjekorra suurust. Neist esimese väärtuseks anname cmd_vel (jutumärkides!), teise väärtuseks Twist ja järjekorra suuruseks 0, sest me ei taha, et sõnumid järjekorras ootaks: rospy.Publisher(“cmd_vel”, Twist, queue_size=0)

See funktsiooni väljakutse tagastab meile objekti, millest võime mõelda kui meie kuulutajast. Selleks, et seda hiljem kasutada ja sinna meile sobivaid sõnumeid saata, määrame ta muutuja velocity_pub väärtuseks: velocity_pub = rospy.Publisher(“cmd_vel”, Twist, queue_size=0)

Viimaseks lisame rea, mis paneb koodi ootama kaks sekundit enne jätkamist: rospy.sleep(2). See lubab süsteemil pärast kuulutaja loomist kõik vajalikud toimingud lõpetada, enne kui hakkame sinna sõnumeid saatma – meil ei ole sellega kiiret.

Pane tähele!

Ära lisa rubriigi nime algusesse kaldkriipsu. Nii hoiame koodi kasutusvõimalused paindlikumad.

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

rospy.init_node("velocity_publisher")
velocity_pub = rospy.Publisher("cmd_vel", Twist, queue_size=0)
rospy.sleep(2)

robot_vel = Twist()
robot_vel.linear.x = 0.1
robot_vel.linear.y = 0.0
robot_vel.linear.z = 0.0
robot_vel.angular.x = 0.0
robot_vel.angular.y = 0.0
robot_vel.angular.z = 0.0

Tühja Twist-sõnumi loomiseks kasutame funktsiooni Twist(). Sedasi loodud sõnumi määrame muutuja robot_vel väärtuseks.

Seejärel saame Twist-sõnumi väljadele ükshaaval ligi, lisades vastloodud muutujale lõppu, missugust komponenti soovime muuta või lugeda: näiteks .linear.x või .angular.z. Kasutame seda, et anda kõigile Twist-sõnumi väljadele väärtuseks 0, peale lineaarse liikumise x-komponendi, mille väärtuseks anname 0.1. See peaks panema meie roboti otsesuunas edasi liikuma kiirusega 0.1 m/s.

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

rospy.init_node("velocity_publisher")
velocity_pub = rospy.Publisher("cmd_vel", Twist, queue_size=0)
rospy.sleep(2)

robot_vel = Twist()
robot_vel.linear.x = 0.1
robot_vel.linear.y = 0.0
robot_vel.linear.z = 0.0
robot_vel.angular.x = 0.0
robot_vel.angular.y = 0.0
robot_vel.angular.z = 0.0

velocity_pub.publish(robot_vel)

Nüüd kui sõnumi sisu on kirjeldatud, on viimase sammuna tarvis see sõnum rubriigis cmd_vel kuulutada. Selleks kasutame eespool defineeritud kuulutajat nimega velocity_pub, mis oskab täpselt seda: kuulutada Twist-sõnumeid rubriigis cmd_vel. Ühe sõnumi kuulutamiseks kasutame kuulutajas leiduvat meetodit publish, mis võtab argumendiks vastloodud sõnumi.

#!/usr/bin/env python3
import rospy
from geometry_msgs.msg import Twist

def main():
    rospy.init_node("velocity_publisher")
    velocity_pub = rospy.Publisher("cmd_vel", Twist, queue_size=0)
    rospy.sleep(2)

    robot_vel = Twist()
    robot_vel.linear.x = 0.1
    robot_vel.linear.y = 0.0
    robot_vel.linear.z = 0.0
    robot_vel.angular.x = 0.0
    robot_vel.angular.y = 0.0
    robot_vel.angular.z = 0.0

    velocity_pub.publish(robot_vel)

if __name__ == '__main__':
    try:
        main()
    except rospy.ROSInterruptException:
        pass

Pane tähele, et siin näites on peale uute koodiridade muudetud ka mõningate olemasolevate taanet.

ROSi koodi Pythonis struktureerimiseks on ilus luua main-funktsioon, mida kutsutakse välja ainult siis, kui käivitatakse tõepoolest seda faili, mitte ei impordita teda mujale. Lisaks on hea main-funktsiooni väljakutse panna try ja except ploki sisse, mis jälgib, ega koodi käivitamist kuidagi ei häirita (nt Ctrl+C vajutades) – siis saame soovi korral koodi viisakalt peatada.

Liigutame oma eelnevalt loodud koodilõigu (välja arvatud koodi päis) main-funktsiooni sisse ja lisame koodi lõppu osa, mis seda välja kutsub.

Kood töötaks ka ilma eraldi main-funktsiooni loomata, aga hea praktika on see sellegipoolest lisada.