User Tools

Site Tools


ice:commands:overview

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
ice:commands:overview [2013/12/04 20:11] Michael Radunskyice:commands:overview [2023/11/30 21:29] (current) – external edit 127.0.0.1
Line 4: Line 4:
 we recommend talking to the Master board via USB Serial using a terminal program such as  we recommend talking to the Master board via USB Serial using a terminal program such as 
 [[http://www.chiark.greenend.org.uk/~sgtatham/putty/| putty]]. [[http://www.chiark.greenend.org.uk/~sgtatham/putty/| putty]].
- 
  
 //Note: All commands are case insensitive.// //Note: All commands are case insensitive.//
 +
 +There are 2 types of commands: 
 +  * Commands for the Master board
 +  * Commands for individual Slave boards, routed by the Master.
 +
 +All commands for the Master Board are prefixed with the character "#", so Commands **#Slave** and **#Devices**
 +are commands for the master. Any command that does not start with "#" will be sent to the current slave board
 +that the master is talking to. The **#Slave** command shows/sets what slot (1-8) the master board is talking to.
 +
 +===== Sample Conversation =====
 +
 +For example, let's say you have a Quad Temp board in Slot 2 and a Peak Lock Servo & Current Controller 
 +in Slot 5. Then you may have the following conversation over the serial:
 +
 +  #Slave
 +  6
 +  #Slave 2
 +  2
 +  SetTemp 3 24.56
 +  24.56
 +  Bipolar 3 Off
 +  Off
 +  #Slave 5
 +  Laser Off
 +  Off
 +  
 +A translation of the above conversation with the ICE Master board is as follows:
 +
 +|What slave device are you talking to?  |
 +|  I'm talking to the device in slot 6 (Master)|
 +|Please start talking to the device in slot 2  |
 +|  Ok, I'm now talking to the device in slot 2 (Master)|
 +|Set the temperature setpoint of channel 3 to 24.56°C  |
 +|  Done, set to 24.56°C  (Quad Temp in Slot 2)|
 +|Disable bipolar mode for channel 3  |
 +|  Done, bipolar mode is now off (Quad Temp in Slot 2)|
 +|Please start talking to the device in slot 5  |
 +|  Ok, I'm now talking to the device in slot 5 (Master)|
 +|Please turn off the laser  |
 +|  Ok, the laser is now off (Peak Lock in Slot 5)|
 +
 +
 +===== Sample Command Description =====
  
 The documentation for every command will look like the example below: The documentation for every command will look like the example below:
-<function=ICEfunc|0=TempMin&1=I:CHANNEL:3;F:MINTEMP:14.32&2=14.3&3=26>+<function=ICEfunc?0=TempMin&1=I:CHANNEL:3;F:MINTEMP:14.32&2=14.3&3=26>
 Sets the minimum temperature for channel CHANNEL to MINTEMP. Returns **TempMin?**.  Sets the minimum temperature for channel CHANNEL to MINTEMP. Returns **TempMin?**. 
  
Line 23: Line 65:
 shows what should be typed into //putty// or similar terminal program and the second line is a sample of the  shows what should be typed into //putty// or similar terminal program and the second line is a sample of the 
 output sent back to the terminal program after the first line is completed and ENTER is pressed. output sent back to the terminal program after the first line is completed and ENTER is pressed.
- 
ice/commands/overview.1386187896.txt.gz · Last modified: 2021/08/26 14:26 (external edit)