root/Lego/nxc/nxc.api

Revision 15, 10.6 kB (checked in by Jan-Klaas Kollhof, 6 months ago)

added bpa dropzone map

  • Property svn:keywords set to LastChangedDate LastChangedBy Revision Date Author
Line 
1# Taken from the NXC readme.txt
2
3Acquire(mutex)
4Release(mutex)
5
6Precedes(task1, task2, ..., taskn)
7Follows(task1, task2, ..., taskn)
8
9ButtonCount(btn, reset)
10ButtonPressed(btn, reset)
11ReadButtonEx(btn, reset, pressed, count)
12
13ClearSensor(port)
14ResetSensor(port)
15Sensor(port)
16SensorUS(port)
17SetSensorLight(port)
18SetSensorSound(port)
19SetSensorTouch(port)
20SetSensorLowspeed(port)
21SetSensorType(port, type)
22SetSensorMode(port, mode)
23SetInput(port, field, value)
24GetInput(port, field)
25SensorType(p)
26SensorMode(p)
27SensorRaw(p)
28SensorNormalized(p)
29SensorScaled(p)
30SensorInvalid(p)
31
32
33FirstTick()
34CurrentTick()
35Wait(ms)
36ResetSleepTimer()
37
38IOMA(num)
39SetIOMA(num)
40FreeMemory()
41BatteryLevel()
42PowerDown()
43RebootInFirmwareMode()
44
45ClearScreen()
46NumOut(x, y, number, cls=false)
47TextOut(x, y, string, cls=false)
48GraphicOut(x, y, filename, cls=false)
49GraphicOutEx(x, y, filename, vars, cls=false)
50CircleOut(x, y, radius, cls=false)
51LineOut(x1, y1, x2, y2, cls=false)
52PointOut(x, y, cls=false)
53RectOut(x, y, width, height, cls=false)
54ResetScreen()
55
56Coast(ports)
57Float(ports)
58Off(ports)
59OnFwd(ports, power)
60OnRev(ports, power)
61OnFwdReg(ports, power, regmode)
62OnRevReg(ports, power, regmode)
63OnFwdSync(ports, power, turnpct)
64OnRevSync(ports, power, turnpct)
65CoastEx(ports, reset)
66OffEx(ports, reset)
67OnFwdEx(ports, power, reset)
68OnRevEx(ports, power, reset)
69OnFwdRegEx(ports, power, regmode, reset)
70OnRevRegEx(ports, power, regmode, reset)
71OnFwdSyncEx(ports, power, turnpct, reset)
72OnRevSyncEx(ports, power, turnpct, reset)
73RotateMotor(ports, power, angle)
74RotateMotorEx(ports, power, angle, turnpct, sync, stop)
75RotateMotorPID(ports, power, angle, p, i, d)
76RotateMotorExPID(ports, power, angle, turnpct, sync, stop, p, i, d)
77
78SetOutput(ports, field1, value1, ..., fieldN, valueN)
79
80GetOutput(port, field)
81MotorMode(p)
82MotorPower(p)
83MotorActualSpeed(p)
84MotorTachoCount(p)
85MotorTachoLimit(p)
86MotorRunState(p)
87MotorTurnRatio(p)
88MotorRegulation(p)
89MotorOverload(p)
90MotorRegPValue(p)
91MotorRegIValue(p)
92MotorRegDValue(p)
93MotorBlockTachoCount(p)
94MotorRotationCount(p)
95
96ResetTachoCount(ports)
97ResetBlockTachoCount(ports)
98ResetRotationCount(ports)
99ResetAllTachoCounts(ports)
100
101PlayFile(filename)
102PlayFileEx(filename, volume, loop)
103PlayTone(frequency, duration)
104PlayToneEx(frequency, duration, volume, loop)
105SoundFlags()
106SoundState()
107StopSound()
108
109Random() // signed word value
110Random(max) // unsigned word value
111
112start taskname
113ExitTo(taskname)
114Stop(bvalue)
115
116abs(n)
117sign(n)
118
119StrToNum(str)
120StrLen(str)
121StrIndex(str, idx)
122
123str = NumToStr(num)
124str = StrCat(str1, str2, ..., strN)
125str = SubStr(string, idx, len)
126str = StrReplace(string, idx, strnew)
127str = Flatten(num)
128str = ByteArrayToStr(a)
129
130ByteArrayToStrEx(a, s)
131StrToByteArray(s, a)
132num = ArrayLen(a)
133ArrayInit(a, val, cnt)
134ArraySubset(aout, asrc, idx, len)
135ArrayBuild(aout, src1, ..., srcN)
136
137GetLSInputBuffer(p, offset, cnt, data)
138GetLSOutputBuffer(p, offset, cnt, data)
139GetDisplayNormal(x, line, cnt, data)
140GetDisplayPopup(x, line, cnt, data)
141GetBTInputBuffer(offset, cnt, data)
142GetBTOutputBuffer(offset, cnt, data)
143GetHSInputBuffer(offset, cnt, data)
144GetHSOutputBuffer(offset, cnt, data)
145GetUSBInputBuffer(offset, cnt, data)
146GetUSBOutputBuffer(offset, cnt, data)
147GetUSBPollBuffer(offset, cnt, data)
148
149str = BTDeviceName(p)
150str = BTConnectionName(p)
151str = BTConnectionPinCode(p)
152str = BrickDataName()
153
154GetBTDeviceAddress(p, data)
155GetBTConnectionAddress(p, data)
156GetBrickDataAddress(data)
157
158SoundFrequency()
159SoundDuration()
160SoundSampleRate()
161SoundMode()
162SoundVolume()
163
164ButtonPressCount(b)
165ButtonLongPressCount(b)
166ButtonShortReleaseCount(b)
167ButtonLongReleaseCount(b)
168ButtonReleaseCount(b)
169ButtonState(b)
170
171CommandFlags()
172UIState()
173UIButton()
174VMRunState()
175BatteryState()
176BluetoothState()
177UsbState()
178SleepTimeout()
179SleepTimer()
180RechargeableBattery()
181Volume()
182OnBrickProgramPointer()
183
184CustomSensorZeroOffset(p)
185CustomSensorPercentFullScale(p)
186CustomSensorActiveStatus(p)
187SensorBoolean(p)
188SensorDigiPinsDirection(p)
189SensorDigiPinsStatus(p)
190SensorDigiPinsOutputLevel(p)
191
192MotorPwnFreq()
193
194LSInputBufferInPtr(p)
195LSInputBufferOutPtr(p)
196LSInputBufferBytesToRx(p)
197LSOutputBufferInPtr(p)
198LSOutputBufferOutPtr(p)
199LSOutputBufferBytesToRx(p)
200LSMode(p)
201LSChannelState(p)
202LSErrorType(p)
203LSState()
204LSSpeed()
205
206DisplayEraseMask()
207DisplayUpdateMask()
208DisplayDisplay()
209DisplayFlags()
210DisplayTextLinesCenterFlags()
211
212BTDeviceClass(p)
213BTDeviceStatus(p)
214BTConnectionClass(p)
215BTConnectionHandleNum(p)
216BTConnectionStreamStatus(p)
217BTConnectionLinkQuality(p)
218BrickDataBluecoreVersion()
219BrickDataBtStateStatus()
220BrickDataBtHardwareStatus()
221BrickDataTimeoutValue()
222BTInputBufferInPtr()
223BTInputBufferOutPtr()
224BTOutputBufferInPtr()
225BTOutputBufferOutPtr()
226HSInputBufferInPtr()
227HSInputBufferOutPtr()
228HSOutputBufferInPtr()
229HSOutputBufferOutPtr()
230USBInputBufferInPtr()
231USBInputBufferOutPtr()
232USBOutputBufferInPtr()
233USBOutputBufferOutPtr()
234USBPollBufferInPtr()
235USBPollBufferOutPtr()
236BTDeviceCount()
237BTDeviceNameCount()
238HSFlags()
239HSSpeed()
240HSState()
241USBState()
242
243SetSoundFrequency(n)
244SetSoundDuration(n)
245SetSoundSampleRate(n)
246SetSoundFlags(n)
247SetSoundState(n)
248SetSoundMode(n)
249SetSoundVolume(n)
250
251SetCommandFlags(n)
252SetUIState(n)
253SetUIButton(n)
254SetVMRunState(n)
255SetBatteryState(n)
256SetBluetoothState(n)
257SetUsbState(n)
258SetSleepTimeout(n)
259SetSleepTimer(n)
260SetVolume(n)
261SetOnBrickProgramPointer(n)
262ForceOff(n)
263
264SetCustomSensorZeroOffset(p, n)
265SetCustomSensorPercentFullScale(p, n)
266SetCustomSensorActiveStatus(p, n)
267SetSensorBoolean(p, n)
268SetSensorDigiPinsDirection(p, n)
269SetSensorDigiPinsStatus(p, n)
270SetSensorDigiPinsOutputLevel(p, n)
271
272SetMotorPwnFreq(n)
273
274SetLSInputBuffer(p, offset, cnt, data)
275SetLSInputBufferInPtr(p, n)
276SetLSInputBufferOutPtr(p, n)
277SetLSInputBufferBytesToRx(p, n)
278SetLSOutputBuffer(p, offset, cnt, data)
279SetLSOutputBufferInPtr(p, n)
280SetLSOutputBufferOutPtr(p, n)
281SetLSOutputBufferBytesToRx(p, n)
282SetLSMode(p, n)
283SetLSChannelState(p, n)
284SetLSErrorType(p, n)
285SetLSState(n)
286SetLSSpeed(n)
287
288SetDisplayEraseMask(n)
289SetDisplayUpdateMask(n)
290SetDisplayDisplay(n)
291SetDisplayFlags(n)
292SetDisplayTextLinesCenterFlags(n)
293SetDisplayNormal(x, line, cnt, data)
294SetDisplayPopup(x, line, cnt, data)
295
296SetBTDeviceName(p, str)
297SetBTDeviceAddress(p, addr)
298SetBTConnectionName(p, str)
299SetBTConnectionPinCode(p, code)
300SetBTConnectionAddress(p, addr)
301SetBrickDataName(str)
302SetBrickDataAddress(p, addr)
303SetBTDeviceClass(p, n)
304SetBTDeviceStatus(p, n)
305SetBTConnectionClass(p, n)
306SetBTConnectionHandleNum(p, n)
307SetBTConnectionStreamStatus(p, n)
308SetBTConnectionLinkQuality(p, n)
309SetBrickDataBluecoreVersion(n)
310SetBrickDataBtStateStatus(n)
311SetBrickDataBtHardwareStatus(n)
312SetBrickDataTimeoutValue(n)
313SetBTInputBuffer(offset, cnt, data)
314SetBTInputBufferInPtr(n)
315SetBTInputBufferOutPtr(n)
316SetBTOutputBuffer(offset, cnt, data)
317SetBTOutputBufferInPtr(n)
318SetBTOutputBufferOutPtr(n)
319SetHSInputBuffer(offset, cnt, data)
320SetHSInputBufferInPtr(n)
321SetHSInputBufferOutPtr(n)
322SetHSOutputBuffer(offset, cnt, data)
323SetHSOutputBufferInPtr(n)
324SetHSOutputBufferOutPtr(n)
325SetUSBInputBuffer(offset, cnt, data)
326SetUSBInputBufferInPtr(n)
327SetUSBInputBufferOutPtr(n)
328SetUSBOutputBuffer(offset, cnt, data)
329SetUSBOutputBufferInPtr(n)
330SetUSBOutputBufferOutPtr(n)
331SetUSBPollBuffer(offset, cnt, data)
332SetUSBPollBufferInPtr(n)
333SetUSBPollBufferOutPtr(n)
334SetBTDeviceCount(n)
335SetBTDeviceNameCount(n)
336SetHSFlags(n)
337SetHSSpeed(n)
338SetHSState(n)
339SetUSBState(n)
340
341CreateFile(fname, fsize, handle)
342OpenFileAppend(fname, fsize, handle)
343OpenFileRead(fname, fsize, handle)
344CloseFile(handle)
345ResolveHandle(fname, handle, writeable)
346RenameFile(oldname, newname)
347DeleteFile(fname)
348Read(handle, n)
349ReadLn(handle, n)
350ReadBytes(handle, len, buf)
351Write(handle, n)
352WriteLn(handle, n)
353WriteString(handle, str, cnt)
354WriteLnString(handle, str, cnt)
355WriteBytes(handle, buf, cnt)
356WriteBytesEx(handle, len, buf)
357
358SendMessage(queue, msg)
359ReceiveMessage(queue, clear, msg)
360
361LowspeedStatus(port, bready)
362LowspeedBytesReady(port)
363LowspeedCheckStatus(port)
364LowspeedWrite(port, retlen, buffer)
365LowspeedRead(port, buflen, buffer)
366
367I2CStatus(port, bready)
368I2CBytesReady(port)
369I2CCheckStatus(port)
370I2CWrite(port, retlen, buffer)
371I2CRead(port, buflen, buffer)
372I2CBytes(port, inbuf, count, outbuf)
373
374BluetoothStatus(conn)
375BluetoothWrite(conn, buffer)
376
377result = ReceiveRemoteBool(queue, clear, bval)
378result = ReceiveRemoteNumber(queue, clear, val)
379result = ReceiveRemoteString(queue, clear, str)
380result = ReceiveRemoteMessageEx(queue, clear, str, val, bval)
381result = SendRemoteBool(conn, queue, bval)
382result = SendRemoteNumber(conn, queue, val)
383result = SendRemoteString(conn, queue, str)
384result = SendResponseBool(queue, bval)
385result = SendResponseNumber(queue, val)
386result = SendResponseString(queue, str)
387
388result = RemoteMessageRead(conn, queue)
389result = RemoteMessageWrite(conn, queue, msg) // alias for SendRemoteString
390result = RemoteStartProgram(conn, filename)
391result = RemoteStopProgram(conn)
392result = RemotePlaySoundFile(conn, filename, bloop)
393result = RemotePlayTone(conn, frequency, duration)
394result = RemoteStopSound(conn)
395result = RemoteKeepAlive(conn)
396result = RemoteResetScaledValue(conn, port)
397result = RemoteResetMotorPosition(conn, port, brelative)
398result = RemoteSetInputMode(conn, port, type, mode)
399result = RemoteSetOutputState(conn, port, speed, mode, regmode, turnpct, runstate, tacholimit)
400
401result = Sqrt(X)
402result = Sin(X)
403result = Cos(X)
404result = Asin(X)
405result = Acos(X)
406
407SysCall(func, args)
408
409SysFileOpenRead(FileOpenType & args)
410SysFileOpenWrite(FileOpenType & args)
411SysFileOpenAppend(FileOpenType & args)
412SysFileRead(FileReadWriteType & args)
413SysFileWrite(FileReadWriteType & args)
414SysFileClose(FileCloseType & args)
415SysFileResolveHandle(FileResolveHandleType & args)
416SysFileRename(FileRenameType & args)
417SysFileDelete(FileDeleteType & args)
418
419SysSoundPlayFile(SoundPlayFileType & args)
420SysSoundPlayTone(SoundPlayToneType & args)
421SysSoundGetState(SoundGetStateType & args)
422SysSoundSetState(SoundSetStateType & args)
423
424SysDrawText(DrawTextType & args)
425SysDrawPoint(DrawPointType & args)
426SysDrawLine(DrawLineType & args)
427SysDrawCircle(DrawCircleType & args)
428SysDrawRect(DrawRectType & args)
429SysDrawGraphic(DrawGraphicType & args)
430SysSetScreenMode(SetScreenModeType & args)
431
432SysReadButton(ReadButtonType & args)
433
434SysCommLSWrite(CommLSWriteType & args)
435SysCommLSRead(CommLSReadType & args)
436SysCommLSCheckStatus(CommLSCheckStatusType & args)
437
438SysRandomNumber(RandomNumberType & args)
439
440SysGetStartTick(GetStartTickType & args)
441
442SysMessageWrite(MessageWriteType & args)
443SysMessageRead(MessageReadType & args)
444
445SysCommBTWrite(CommBTWriteType & args)
446SysCommBTCheckStatus(CommBTCheckStatusType & args)
447
448SysKeepAlive(KeepAliveType & args)
449
450SysIOMapRead(IOMapReadType & args)
451SysIOMapWrite(IOMapWriteType & args)
452
453SysIOMapReadByID(IOMapReadByIDType & args)
454SysIOMapWriteByID(IOMapWriteByIDType & args)
455
456SysDisplayExecuteFunction(DisplayExecuteFunctionType & args)
457SysCommExecuteFunction(CommExecuteFunctionType & args)
458SysLoaderExecuteFunction(LoaderExecuteFunctionType & args)
459
Note: See TracBrowser for help on using the browser.