User Manual - x-io Technologies
Contents
1. network will receive messages from the x OSC The outgoing port specifies the port on which your computer should listen for OSC messages and the incoming port specifies the port to which your computer should send The local IP shows the current IP address of the x OSC 6 3 Input Settings The input section is whereindividual input channels can be configured Each input channel can be set to be digital or analogue as described in section 4 1 In digital mode the pull up down state can be set in analogue mode the compare threshold can be set range 0 0 1 0 At the top of this section is the message rate for the analogue input readings 0 0 350 0Hz www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 Inputs Sample Rate 50 0 Hz Input 1 Digital Pull down Pull up Input 2 Digital Pull down Pull up Input 3 Digital 4 Pull down C Pull up Input 4 Digital Pull down Pull up Input 5 Digital Pull down Pull up Input 6 Digital 4 Pull down C Pull up Input 7 Digital Pull down C Pull up Input 8 Digital Pulledown Pull up Input 9 Analog 0 0 Compare Input 10 analog 0 0 Compare Input 11 Analog oo Compare Input 12 Analog 0 0 Compare Input 13 Analog 0 0 Compare Input 14 Analog 0 0 Compare Input 15 analog 0 0 Compare i Input 16 Analog 0 0 Compare 6 4 Outp2. O are false and values greater than O are true This section provides a short look up table for the x OSC OSC dictionary 7 1 1 x OSC to host messages Message Description rinpa C261 el pet each integer argument is the current state of one of the digital inputs 0 or 1 Sent only when the state of a pin changes each f is the current value of one of the analogue input channels Sent at the analogue input message rate input analog compare iiiiiiiiiiiiiiii Each integer argument is the current battery f ping s 7 1 2 Host to x OSC messages compare state of one of the digital inputs 0 if below or 1 if above the threshold Sent only when a threshold is crossed f is the current battery voltage s is the x OSC local IP address Table 1 x OSC to host message summery If the x OSC receives a message that does not match any message in the following table the LED will flash red Message input rate f input analog channel input analog compare channel f www X iO0 co uk Description f sets the message rate for the analogue input readings the specified input channel 1 16 is set to analogue mode the specified input channel 1 16 threshold is set to the value of f 0 0 1 0 x OSC User Manual v0 0 Release date 23 May 2013 incut obit eel elarcvaigtan the specified input channel 1 16 is set to digital mode input digital up ohannel enables the pull up for speci
3. Simply open your preferred browser and in the address bar type in the x OSC IP address If the x OSC is in ad hock mode and you are connected to its network its IP address will be http 169 254 1 1 If the x OSC is in infrastructure mode you can obtain the IP address by pressing the ping button and listening for an OSC message on the x OSC outgoing port number 8000 by default If at any time you cannot connect to the x OSC simply press and hold the ping button for three seconds to return the device to ad hock mode with an open network you can then access the settings page by joining its networkand navigating to the http 169 254 1 1 address The remainder of this section will briefly explain the x OSC browser settings page Note that changes made to any of these settings are only applied when the Save Settings button is pressed lt 4 OSC i Settings Network OSC Inputs Outputs Save Settings Copyright 2013 x io Technologies 6 1 Network Settings In the Network section the x OSC can be switched between ad hock and infrastructure modes see section 5 Network aoe ee NE see O Infrastructure SSID eee In ad hock mode the network name SSID of the x OSC hosted WiFi network can be set When the x OSC is in ad hock mode the LED will shine cyan www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 Network Network type Ad hoc Infrastructure SS
4. ad hoc mode the x OSC creates a WiFi network that other devices are able to join By default this network is called x OSC and will show up as an available WiFi network in your computer s network settings this network name SSID can be changed in the device settings see section 6 The x OSC s wireless ad hock network is open by default although WEP security can be enabled again see section 6 At any time it is possible to enter ad hock mode by pressing and holding the ping button for three seconds the LED will begin to flash Cyan when the device switches back to ad hock mode 5 2 Infrastructure Mode Magenta LED Infrastructure mode allows x OSC to connect to an existing WiFi network The devicecan be configured to have a static IP address or to obtain one dynamically from the network server using DHCP If the x OSC IP address is unknown simply press the ping button see section 4 which will cause the x OSC to broadcast an OSC message indicating the IP addresson its outgoing port number 8000 by default Alternatively another network device can broadcasta ping OSC message to achieve the same result Infrastructure mode enables multiple x OSC devices to operate on the same network and to be addressed by multiple host computersconnected to the same network www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 6 Browser Configuration The x OSC can be easily configured over WiFi using an internet browser
5. ID My Network Security wPaz Passphrase passphrase _ Use DHCP o IP address 169 254 1 1 Subnet mask 255 255 0 0 _ Gateway 0 0 0 0 In infrastructure mode you can enter the name of the network SSID that you would like the x OSC to join setting the security mode accordingly Security types Open WPA and WPA2 are supported where the latter two require entry of a security passphrase Inthis section you can disable DHCP if you would like to specify a static IP address for x OSC When you are happy that you have entered the correct infrastructure settings click the Save Settings button to reboot the x OSC with the new infrastructure settings The LED will then flash magenta until it has successfully joined the network when it will shine constantly Connection should take approximately 30 seconds if flashing continues for more than one minute then review the infrastructure settings for errors by pressing and holding the ping button for three seconds to revert the x OSC to ad hock mode see section 6 above 6 2 OSC Settings In the OSC section the IP and port settings for the receipt and delivery of OSC messages can be configured Host IP 255 255 255 255 Port outgoing sooo Port incoming 3000 _ Local IP 169 254 1 1 The host IP is the IP address of the devicethat the x OSC will deliver messages to The default IP address is 255 255 255 255 which is a special broadcast address which means that all devices on the
6. PWM mode for specified channel s Set PWM frequency e output channel pwm freg f e Sets frequency in Hz of PWM output for specified channel s Values limited to integers between 5 Hz and 250 000 Hz ms Set PWM duty cycle e output channel pwm duty f e Sets duty cycle in of PWM output for specified channel s up to 16 bit resolution Values limited to integers between 0 and 100 Set LED colour o lca e Three integers corresponding to the RGB values of the LED Each value is limited to between 0 and 255 Clear LED colour e ileagelear e Reverts LED to status colour WWW X I0 co Uk x OSC User Manual v0 0 Release date 23 May 2013 Ping e ping e Causes the x OSC to respond with a ping message indicating its IP address www X iO0 co uk
7. SZ OSC User Manual Version 0 0 Preliminary Release AA AMA TECHNOLOGIES Copyright 2013 x io Technologies Ltd www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 Contents L OVE VOW E E E E 3 LOPE SOM CONTON OSC a E E E A 3 Be UO acest ene sere certs casos deers cae seeccneeec data cone cea ssnsentesahes ac sates suv dteaeeeseusesene ceae oueesenetstaes seeds 4 yi Tadic INNA E E eu urea E atic cates ac eae vase nee E E E E E E 4 4 1 x OSC Hardware Input CONNECTtIONS ccccesccccsseeccssceceececeececeeceeeneceeeneessencesseecessueceseneeeeeaeetees 5 4 2 x OSC Hardware Output CONNECTIONS ccccccssscccsecccseccesceceececeececeeceeeeeeeueessuecessgecessueeenees 5 CONDE CENE Ce TEKI C ree neem Ce eee ne ee Ce ee ee eee 5 De ds CNC MOGE yay LED her E 5 5 2 Infrastructure Mode Magenta LED cccccccccsssseccecceessecceceeeeecceseeeeeecceeeueaeeeeseeeeseceeesageeeeeees 5 Bx BROW SO CO il SU OW rE EEEE E E E 6 die INGUIO SOUS e sedate cues ssenetseitetcxoeenesdaute E N 6 2 OS Se UIE ea E ue ickvec tres uaa cade eter crea ed ow vee en E uaont ent nkneenl 7 6 3 Input Settings 0 0 00006 00 01 A ni Ernan EEEN NEAN SENES ENEDES NEEDE 7 6 4 Output Settings neee EEEE 8 7 Communicating with the x OSC OSC Dictionary cccccccsssecccceseccecescceceeecceeeseceeseecesseeceesaneeees 9 7 1 OSC message summery a o NM ccoscestcescsersevcosecoscos Manes 9 7 1 1 X OSC t
8. ay be connected to sensors producing a voltage in the range 0 3 3 V Each input is sampled with 13 bit resolution and measurements aretransmitted at a specified rate of up to 350 Hz Analogue inputmode also provides a compare function to send a message each time a specified threshold is crossed This enables low latency threshold detection without the need for a high message rate 4 2 x OSC Hardware Output Connections The 16 independent output channels on the x OSC can each be configured to output digital pulse or PWM signals which can also be configuredby browser or OSC over WiFi see sections 6 3 and 7 In digital mode an output can be set to high or low In pulse mode an output can be triggered to generate a pulse with a period of 1 ms to 1 minute at a resolution of 1 ms An output in PWM mode can generate a PWM waveform from 5 Hz to 250 kHz with a duty cycle resolution up to 16 bit PWM may be used witha fixed frequency and variable duty cycle to approximate an analogue signal 5 Connecting to the x OSC x OSC can communicate with single or multiple host computers over a WiFi network in either ad hock or infrastructure networkmodes By default the device will be in ad hock mode although this can be changed easily using an internet browser see section6 While the network connection is being established the LED will flash upon successful network configuration the LED will remain on constantly 5 1 Ad hock Mode Cyan LED In
9. e input channel analog compare f e Sets analogue compare value for specified channel s Value limited between 0 and 1 Also puts input s into analogue mode Set digital input e input channel digital e Sets input to digital mode for specified channel s Set digital pull up e input channel digital up e Sets pull up resistor for digital mode for specified channel s Also puts input s into digital mode www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 Set digital pull down e input channel digital down e Sets pull down resistor for digital mode for specified channel s Also puts input s into digital mode Set digital channel e output channel digital e Sets output to digital mode for specified channel s Set digital channel e output channel digital state i e Sets state of digital output for specified channel s Values less than 0 low values greater than 0 high Set pulse channel e output channel pulse e Sets output to pulse mode for specified channel s and start pulse Set pulse width e output channel pulse width i e Sets pulse width in ms of pulse output for specified channel s and starts pulse Values limited to integers between 1 ms and 60 000 1 minute Set pulse invert e output channel pulse invert i e Sets pulse invert of pulse output for specified channel s and starts pulse Values lt 0 false values gt 0 true Set PWM channel e output channel pwm e Sets output to
10. fied digital input channel 1 16 j Ampue digital down channel enables the pull down for specified digital input channel 1 16 output digital channel the specified output channel 1 16 is set to digital mode output digital state channel i wherei 0or 1 sets the state of the specified output channel output pulse channel triggers a pulse on the specified output channel 1 16 is set to pulse mode Uses the last width and invert values output pulec Width Hannel l triggers a pulse for i milliseconds on the specified channel output pulse invert channel i triggers a pulse on the specified channel 0 16 if i is 1 the pulse is inverted else the pulse is normal output pwm channel the specified output channel 1 16 is set to PWM mode output pwm frequency channel f the specified output channel 1 16 is set to PWM mode with the frequency f 5 0 250000 0 output pwm duty channel f the specified output channel 1 16 is set to PWM mode with the duty f 0 0 100 0 fleas Set i111 the LED colour is set where iii are three rgb integers 0 255 Mel ese ane resets the LED to the network mode colour ping causes the x OSC to broadcast its local IP address Table 2 host to x OSC message summery 7 2 Full OSC Message Documentation 7 2 1 x OSC to host messages Digital input states eee cicgilica ip a e 16 integers describing the state of the digital input channels 1 high 0 low In
11. o host MCSSQGESre ee oiae e sss rT sss 505s Meee 9 7 1 2 Host to x OSC MESSGGCS ee aiia eea e ce 9 7 2 Full OSC Message Documentation cgilleeeeeeemen neers te este aetree eae nan enn ta ane einen ne een n neenenneEEE 10 7 2 1 X OSC to NOSUINESSAG CSc eee eee 10 7 2 2 Host to x OSC messadge S e occ cece ss Re 11 www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 1 Overview x OSC is a robust high performance 32 channel wireless interface device that makes it simple to control and respond to a limitless range of electronics without having to learn a new programming language or install device drivers All you need is a WiFi enabled computer some basic programming skills and you are ready to make sophisticated interactive systems 2 Open Sound Control OSC x OSC communications take place over WiFi using the ubiquitous OSC protocol which is a versatile network protocol supported in more than 80 different programming languages and software environments For an extensive list see htto opensoundcontrol org implementations A fuller description of OSC is provided in section7 We are maintaining a growing range of x OSC example projects for the most popular platforms environments here http x io co uk x osc OUTPUTS OOOOOOOOS SOQSSOLE OO www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 3 Features Inputs e 16x independently configurable channels e M
12. odes analogue digital serial e High performance ADC 14 bit resolution 350 Hz update e Analogue comparator functionality e Selectable pull up down resistors digital mode only e 16x independently configurable channels e Modes digital pulse PWM serial e High performance PWM 5 Hz to 250 kHz up to 16 bit resolution e Source sink 50 mA per channel e Supports ad hoc and infrastructure networks e Fully configurable via standard internet browser e Small form factor 45 x 32 mm e Regulated 3 3V 700 mA output e Battery level 4 Hardware O1 010 O2 520 O3 230 O4 240 Os5 050 o 40 O7 O7 m WU 1 O8 80 2 O9 90 O10 100 Q11 10 O12 120 13 130 14 m 1440 15 150 Ou 160 OVOUT VBATT s Liew GND L_ Figure 1 x OSC top view 16 analogue digital inputs 16 digital outputs inc high speed PWM for analogue output Ping button Status LED Regulated power out 3 3 V Battery connector Battery output or power input 3 5 5 5 V OUE et www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 4 1 x OSC Hardware Input Connections The x OSC is equipped with 16 independent input channels which can each be configured to either analogue digital or serial modes using a browser or OSC over WiFi see sections 6 3 and 7 Digital inputs can be configured to use internal pull up down resistors and to minimise latency their state is only transmitted on change Analogue inputs m
13. put channels not in digital mode will have a value of 0 e This message is sent each time a digital input changes values www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 Analogue input values Jinpur analogii riire e 16 floats describing the value of the analogue input channels 0 0 to 1 0 corresponding to 0 to 3 3V 13 bit resolution Input channels not in analogue mode will have a value of 0 e This message is sent at the analogue message rate Analogue compare values e input analog compare iiiiiiiiiiiiiiil e 16 integers the state of the analogue compare channels 1 input is equal or greater than compare value 0 value is less than compare value Input channels not in analogue mode will have a value of 0 e This message is sent each time an analogue compare state changes values Battery voltage e battery f e Asingle float describing the battery voltage in volts e This message is sent every 5 seconds e ping s e A string representation of x OSC s local IP address e This message is sent each time the button is pressed or after a ping message Is received e Always a broadcast i e destination IP 255 255 255 255 7 2 2 Host to x OSC messages Set analogue sample rate e input rate f e The analogue sample rate in Hz The value will be limited between 0 and 350 Hz Set analogue channel e input channel analog e Sets input to analogue mode for specified channel s Set analogue compare
14. ut Settings The output section is where the individual output channel modes can be configured Each channel can be set to digital pulse or PWM modes with relevant parameters for each mode as shown in Figure 2as described in section 4 2 Outputs i Output 1 Digital Low High Output 2 Digital Low O High Output 3 Digital Low O High Output 4 Digital Low O High _ Output 5 Digital Low High Output 6 Pulse 100 ms O Invert Output 7 Pulse 100 ms O Invert Output 8 Pulse 100 ms O Invert Output 9 Pulse foo ms O Invert Output 10 pre 100 lms O Invert i Output 11 Pulse 100 ms O Invert i Output 12 PwM 1000 0 Hz 50 0 _ Output 13 pwm 1000 0 Hz 50 0 i Output 14 PwM 1000 0 Hz 50 0 _ Output 15 PwM 1000 0 Hz 50 0 Output 16 PWM 1000 0 Hz 500 Figure 2 Output browser settings www X iO0 co uk x OSC User Manual v0 0 Release date 23 May 2013 7 Communicating with the x OSC OSC Dictionary x OSC Implements OSC 1 0 as per the specification with the following exceptions notes 7 1 OSC message summery character lists e g string or the associated operators the address pattern is not case sensitive and are not supported float and integer arguments are interchangeable for all Boolean arguments represented as integers values less than or equal to
Download Pdf Manuals
Related Search